No-code docs
Resources

Sender Profiles

List sender profiles

Retrieve a list of sender profiles associated with the account

GET/workspaces/{workspaceId}/sender-profiles
Authorization
Path parameters
workspaceId*string
Query parameters
Response

OK

Body
results*array of SenderProfile (object)
Request
const response = await fetch('/workspaces/{workspaceId}/sender-profiles', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();
Response
{
  "results": [
    {
      "id": "text",
      "name": "text",
      "email": {
        "username": "text",
        "domain": "text"
      },
      "allowedEntities": [
        {
          "entityType": "team",
          "entityId": "text"
        }
      ],
      "channelId": "text",
      "signature": "text",
      "createdAt": "2024-10-18T03:25:15.987Z",
      "updatedAt": "2024-10-18T03:25:15.987Z"
    }
  ]
}

Create new sender profile

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

POST/workspaces/{workspaceId}/sender-profiles
Authorization
Path parameters
workspaceId*string
Body
name*string
usernamestring
allowedEntitiesnullable array of SenderProfileAllowedEntity (object)
channelId*string
signaturestring
Response

created

Request
const response = await fetch('/workspaces/{workspaceId}/sender-profiles', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "channelId": "text"
    }),
});
const data = await response.json();
Response
{
  "code": "text",
  "message": "text"
}

Get Sender profile

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

GET/workspaces/{workspaceId}/sender-profiles/{senderProfileId}
Authorization
Path parameters
workspaceId*string
senderProfileId*string

Sender Profile UUID

Response

OK

Body
id*string
name*string
emailSenderProfileEmail (object)
allowedEntitiesarray of SenderProfileAllowedEntity (object)
channelId*string
signaturestring
createdAt*string (date-time)
updatedAt*string (date-time)
Request
const response = await fetch('/workspaces/{workspaceId}/sender-profiles/{senderProfileId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();
Response
{
  "id": "text",
  "name": "text",
  "email": {
    "username": "text",
    "domain": "text"
  },
  "allowedEntities": [
    {
      "entityType": "team",
      "entityId": "text"
    }
  ],
  "channelId": "text",
  "signature": "text",
  "createdAt": "2024-10-18T03:25:15.987Z",
  "updatedAt": "2024-10-18T03:25:15.987Z"
}

Update Sender profile

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

PATCH/workspaces/{workspaceId}/sender-profiles/{senderProfileId}
Authorization
Path parameters
workspaceId*string
senderProfileId*string

Sender Profile UUID

Body
namenullable string
usernamenullable string
signaturenullable string
allowedEntitiesnullable array of SenderProfileAllowedEntity (object)
channelIdstring
Response

updated

Body
id*string
name*string
emailSenderProfileEmail (object)
allowedEntitiesarray of SenderProfileAllowedEntity (object)
channelId*string
signaturestring
createdAt*string (date-time)
updatedAt*string (date-time)
Request
const response = await fetch('/workspaces/{workspaceId}/sender-profiles/{senderProfileId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "id": "text",
  "name": "text",
  "email": {
    "username": "text",
    "domain": "text"
  },
  "allowedEntities": [
    {
      "entityType": "team",
      "entityId": "text"
    }
  ],
  "channelId": "text",
  "signature": "text",
  "createdAt": "2024-10-18T03:25:15.987Z",
  "updatedAt": "2024-10-18T03:25:15.987Z"
}

Delete Sender Profile

Remove a specific sender profile.

DELETE/workspaces/{workspaceId}/sender-profiles/{senderProfileId}
Authorization
Path parameters
workspaceId*string
senderProfileId*string

Sender Profile UUID

Response

Deleted

Request
const response = await fetch('/workspaces/{workspaceId}/sender-profiles/{senderProfileId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();
Response
{
  "code": "text",
  "message": "text"
}

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
Authorization
Path parameters
workspaceId*string
Response

ok

Body
results*array of SignatureVariable (object)
Request
const response = await fetch('/workspaces/{workspaceId}/sender-profiles/signature-variables', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();
Response
{
  "results": [
    {
      "id": "text",
      "name": "text",
      "defaultDescription": "text",
      "variable": "text",
      "category": "text",
      "replacementAttribute": "text"
    }
  ]
}

List sender profiles

Retrieve a list of sender profiles associated with a user.

GET/workspaces/{workspaceId}/users/{userId}/sender-profiles
Authorization
Path parameters
workspaceId*string
userId*string
Query parameters
Response

ok

Body
results*array of SenderProfile (object)
Request
const response = await fetch('/workspaces/{workspaceId}/users/{userId}/sender-profiles', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();
Response
{
  "results": [
    {
      "id": "text",
      "name": "text",
      "email": {
        "username": "text",
        "domain": "text"
      },
      "allowedEntities": [
        {
          "entityType": "team",
          "entityId": "text"
        }
      ],
      "channelId": "text",
      "signature": "text",
      "createdAt": "2024-10-18T03:25:15.987Z",
      "updatedAt": "2024-10-18T03:25:15.987Z"
    }
  ]
}

Last updated