No-code docs

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: 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
get
/workspaces/{workspaceId}/sender-profiles
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-10-30T01:14:11.738Z",
      "updatedAt": "2025-10-30T01:14:11.738Z"
    }
  ]
}

Create new sender profile

post

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

Authorizations
Path parameters
workspaceIdstringRequired
Body
namestringRequired
usernamestringOptional
channelIdstring · max: 60Required
signaturestringOptional
Responses
201

created

No content
post
/workspaces/{workspaceId}/sender-profiles
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
Path parameters
workspaceIdstringRequired
senderProfileIdstringRequired

Sender Profile UUID

Responses
200

OK

application/json
get
/workspaces/{workspaceId}/sender-profiles/{senderProfileId}
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-10-30T01:14:11.738Z",
  "updatedAt": "2025-10-30T01:14:11.738Z"
}

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
channelIdstring · max: 60Optional
Responses
200

updated

application/json
patch
/workspaces/{workspaceId}/sender-profiles/{senderProfileId}
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-10-30T01:14:11.738Z",
  "updatedAt": "2025-10-30T01:14:11.738Z"
}

Delete Sender Profile

delete

Remove a specific sender profile.

Authorizations
Path parameters
workspaceIdstringRequired
senderProfileIdstringRequired

Sender Profile UUID

Responses
204

Deleted

No content
delete
/workspaces/{workspaceId}/sender-profiles/{senderProfileId}
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
Path parameters
workspaceIdstringRequired
Responses
200

ok

application/json
get
/workspaces/{workspaceId}/sender-profiles/signature-variables
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
Path parameters
workspaceIdstringRequired
userIdstringRequired
Query parameters
channelIdstring · max: 60Optional

Filter by channelId

Responses
200

ok

application/json
get
/workspaces/{workspaceId}/users/{userId}/sender-profiles
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-10-30T01:14:11.738Z",
      "updatedAt": "2025-10-30T01:14:11.738Z"
    }
  ]
}

Last updated

Was this helpful?