Sender Profiles

List sender profiles

get

Retrieve a list of sender profiles associated with the account

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10optional

Limits the number of results to return

pageTokenstring · max: 8000optional

Pagination token that keeps of track of the current position in the list

reverseboolean · default: falseoptional

Order in which to retrieve the results

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/sender-profiles' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "results": [
    {
      "id": "text",
      "name": "text",
      "email": {
        "username": "text",
        "domain": "text"
      },
      "allowedEntities": [
        {
          "entityType": "team",
          "operation": "view",
          "entityId": "text"
        }
      ],
      "channelId": "text",
      "signature": "text",
      "createdAt": "2025-03-28T18:57:21.463Z",
      "updatedAt": "2025-03-28T18:57:21.463Z"
    }
  ]
}

OK

Create new sender profile

post

Create a new sender profile, defining its name, and other attributes.

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestringrequired

usernamestringoptional

allowedEntitiesobject[] | nullableoptional

channelIdstring · max: 60required

signaturestringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/sender-profiles' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "username": "text",
    "allowedEntities": [
      {
        "entityType": "team",
        "operation": "view",
        "entityId": "text"
      }
    ],
    "channelId": "text",
    "signature": "text"
  }'

201

422

201

No body

created

Get Sender profile

get

Retrieve information about a specific sender profile, including its name, and other attributes.

Authorizations

Path parameters

workspaceIdstringrequired

senderProfileIdstringrequired

Sender Profile UUID

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/sender-profiles/{senderProfileId}' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "id": "text",
  "name": "text",
  "email": {
    "username": "text",
    "domain": "text"
  },
  "allowedEntities": [
    {
      "entityType": "team",
      "operation": "view",
      "entityId": "text"
    }
  ],
  "channelId": "text",
  "signature": "text",
  "createdAt": "2025-03-28T18:57:21.463Z",
  "updatedAt": "2025-03-28T18:57:21.463Z"
}

OK

Update Sender profile

patch

Modify the details of a specific sender profile, such as its name or other attributes.

Authorizations

Path parameters

workspaceIdstringrequired

senderProfileIdstringrequired

Sender Profile UUID

Body

namestring | nullableoptional

usernamestring | nullableoptional

signaturestring | nullableoptional

allowedEntitiesobject[] | nullableoptional

channelIdstring · max: 60optional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/sender-profiles/{senderProfileId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "username": "text",
    "signature": "text",
    "allowedEntities": [
      {
        "entityType": "team",
        "operation": "view",
        "entityId": "text"
      }
    ],
    "channelId": "text"
  }'

200

404

422

200

{
  "id": "text",
  "name": "text",
  "email": {
    "username": "text",
    "domain": "text"
  },
  "allowedEntities": [
    {
      "entityType": "team",
      "operation": "view",
      "entityId": "text"
    }
  ],
  "channelId": "text",
  "signature": "text",
  "createdAt": "2025-03-28T18:57:21.463Z",
  "updatedAt": "2025-03-28T18:57:21.463Z"
}

updated

Delete Sender Profile

delete

Remove a specific sender profile.

Authorizations

Path parameters

workspaceIdstringrequired

senderProfileIdstringrequired

Sender Profile UUID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/sender-profiles/{senderProfileId}' \
  --header 'Authorization: Bearer jwt'

204

404

204

No body

Deleted

List of variable for signature in sender profiles

get

Retrieve a list of variables to use for signature configuration in sender profile.

Authorizations

Path parameters

workspaceIdstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/sender-profiles/signature-variables' \
  --header 'Authorization: Bearer jwt'

200

404

422

200

{
  "results": [
    {
      "id": "text",
      "name": "text",
      "defaultDescription": "text",
      "variable": "text",
      "category": "text",
      "replacementAttribute": "text",
      "langDescription": {}
    }
  ]
}

ok

List sender profiles

get

Retrieve a list of sender profiles associated with a user.

Authorizations

Path parameters

workspaceIdstringrequired

userIdstringrequired

Query parameters

channelIdstring · max: 60optional

Filter by channelId

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/users/{userId}/sender-profiles' \
  --header 'Authorization: Bearer jwt'

200

404

422

200

{
  "results": [
    {
      "id": "text",
      "name": "text",
      "email": {
        "username": "text",
        "domain": "text"
      },
      "allowedEntities": [
        {
          "entityType": "team",
          "operation": "view",
          "entityId": "text"
        }
      ],
      "channelId": "text",
      "signature": "text",
      "createdAt": "2025-03-28T18:57:21.463Z",
      "updatedAt": "2025-03-28T18:57:21.463Z"
    }
  ]
}

ok