Sender Profiles

List sender profiles

get

Retrieve a list of sender profiles associated with the account

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstring · max: 8000Optional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false

Responses

200

OK

application/json

404

Workspace not found

application/json

get

/workspaces/{workspaceId}/sender-profiles

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/sender-profiles HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "results": [
    {
      "id": "text",
      "name": "text",
      "email": {
        "username": "text",
        "domain": "text"
      },
      "allowedEntities": [
        {
          "entityType": "team",
          "operation": "view",
          "entityId": "text"
        }
      ],
      "channelId": "text",
      "signature": "text",
      "createdAt": "2025-12-28T04:37:57.115Z",
      "updatedAt": "2025-12-28T04:37:57.115Z"
    }
  ]
}

Create new sender profile

post

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

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

Body

application/json

namestringRequired

usernamestringOptional

channelIdstring · max: 60Required

signaturestringOptional

Responses

201

created

422

Invalid request

application/json

post

/workspaces/{workspaceId}/sender-profiles

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/sender-profiles HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "name": "text",
  "username": "text",
  "allowedEntities": [
    {
      "entityType": "team",
      "operation": "view",
      "entityId": "text"
    }
  ],
  "channelId": "text",
  "signature": "text"
}

No content

Get Sender profile

get

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

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

senderProfileIdstringRequired

Sender Profile UUID

Responses

200

OK

application/json

404

Sender profile or workspace not found

application/json

get

/workspaces/{workspaceId}/sender-profiles/{senderProfileId}

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/sender-profiles/{senderProfileId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "email": {
    "username": "text",
    "domain": "text"
  },
  "allowedEntities": [
    {
      "entityType": "team",
      "operation": "view",
      "entityId": "text"
    }
  ],
  "channelId": "text",
  "signature": "text",
  "createdAt": "2025-12-28T04:37:57.115Z",
  "updatedAt": "2025-12-28T04:37:57.115Z"
}

Update Sender profile

patch

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

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

senderProfileIdstringRequired

Sender Profile UUID

Body

application/json

namestring | nullableOptional

usernamestring | nullableOptional

signaturestring | nullableOptional

channelIdstring · max: 60Optional

Responses

200

updated

application/json

404

Sender profile or workspace not found

application/json

422

Invalid request

application/json

patch

/workspaces/{workspaceId}/sender-profiles/{senderProfileId}

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/sender-profiles/{senderProfileId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "name": "text",
  "username": "text",
  "signature": "text",
  "allowedEntities": [
    {
      "entityType": "team",
      "operation": "view",
      "entityId": "text"
    }
  ],
  "channelId": "text"
}

{
  "id": "text",
  "name": "text",
  "email": {
    "username": "text",
    "domain": "text"
  },
  "allowedEntities": [
    {
      "entityType": "team",
      "operation": "view",
      "entityId": "text"
    }
  ],
  "channelId": "text",
  "signature": "text",
  "createdAt": "2025-12-28T04:37:57.115Z",
  "updatedAt": "2025-12-28T04:37:57.115Z"
}

Delete Sender Profile

delete

Remove a specific sender profile.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

senderProfileIdstringRequired

Sender Profile UUID

Responses

204

Deleted

404

Sender profile or workspace not found

application/json

delete

/workspaces/{workspaceId}/sender-profiles/{senderProfileId}

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/sender-profiles/{senderProfileId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List of variable for signature in sender profiles

get

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

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

Responses

200

ok

application/json

404

Workspace not found

application/json

422

Invalid request

application/json

get

/workspaces/{workspaceId}/sender-profiles/signature-variables

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/sender-profiles/signature-variables HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

List sender profiles

get

Retrieve a list of sender profiles associated with a user.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

userIdstringRequired

Query parameters

channelIdstring · max: 60Optional

Filter by channelId

Responses

200

ok

application/json

404

Workspace or user not found

application/json

422

Invalid request

application/json

get

/workspaces/{workspaceId}/users/{userId}/sender-profiles

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/users/{userId}/sender-profiles HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "results": [
    {
      "id": "text",
      "name": "text",
      "email": {
        "username": "text",
        "domain": "text"
      },
      "allowedEntities": [
        {
          "entityType": "team",
          "operation": "view",
          "entityId": "text"
        }
      ],
      "channelId": "text",
      "signature": "text",
      "createdAt": "2025-12-28T04:37:57.115Z",
      "updatedAt": "2025-12-28T04:37:57.115Z"
    }
  ]
}