Sender Profiles

Last updated 5 months ago

Was this helpful?

List sender profiles

Retrieve a list of sender profiles associated with the account

get

/workspaces/{workspaceId}/sender-profiles

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

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

Limits the number of results to return

pageTokenstring · max: 8000

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

reverseboolean

Order in which to retrieve the results

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

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

Create new sender profile

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

post

/workspaces/{workspaceId}/sender-profiles

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestringrequired

usernamestring

channelIdstring · max: 60required

signaturestring

allowedEntitiesobject[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

422

No body

created

Get Sender profile

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

get

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

Authorizations

Path parameters

workspaceIdstringrequired

senderProfileIdstringrequired

Sender Profile UUID

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

{
  "id": "text",
  "name": "text",
  "email": {
    "username": "text",
    "domain": "text"
  },
  "channelId": "text",
  "signature": "text",
  "createdAt": "2025-02-21T18:02:57.297Z",
  "updatedAt": "2025-02-21T18:02:57.297Z",
  "allowedEntities": [
    {
      "entityId": "text",
      "entityType": "team",
      "operation": "view"
    }
  ]
}

Update Sender profile

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

patch

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

Authorizations

Path parameters

workspaceIdstringrequired

senderProfileIdstringrequired

Sender Profile UUID

Body

namestring | nullable

usernamestring | nullable

signaturestring | nullable

channelIdstring · max: 60

allowedEntitiesobject[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

422

{
  "id": "text",
  "name": "text",
  "email": {
    "username": "text",
    "domain": "text"
  },
  "channelId": "text",
  "signature": "text",
  "createdAt": "2025-02-21T18:02:57.297Z",
  "updatedAt": "2025-02-21T18:02:57.297Z",
  "allowedEntities": [
    {
      "entityId": "text",
      "entityType": "team",
      "operation": "view"
    }
  ]
}

updated

Delete Sender Profile

Remove a specific sender profile.

delete

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

Authorizations

Path parameters

workspaceIdstringrequired

senderProfileIdstringrequired

Sender Profile UUID

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

404

No body

Deleted

List of variable for signature in sender profiles

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

get

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

Authorizations

Path parameters

workspaceIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

422

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

List sender profiles

Retrieve a list of sender profiles associated with a user.

get

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

Authorizations

Path parameters

workspaceIdstringrequired

userIdstringrequired

Query parameters

channelIdstring · max: 60

Filter by channelId

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

422

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