Sender Profiles

Get Sender profile

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

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

Authorization

useraccessKey

Path parameters

workspaceId*string

senderProfileId*string

Sender Profile UUID

Response

200404

OK

Body

application/json

id*string

name*string

emailSenderProfileEmail (object)

allowedEntitiesarray of SenderProfileAllowedEntity (object)

channelId*string

signaturestring

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200404

{
  "id": "text",
  "name": "text",
  "email": {
    "username": "text",
    "domain": "text"
  },
  "allowedEntities": [
    {
      "entityType": "team",
      "entityId": "text"
    }
  ],
  "channelId": "text",
  "signature": "text",
  "createdAt": "2024-10-13T00:24:50.756Z",
  "updatedAt": "2024-10-13T00:24:50.756Z"
}

Delete Sender Profile

Remove a specific sender profile.

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

Authorization

useraccessKey

Path parameters

workspaceId*string

senderProfileId*string

Sender Profile UUID

Response

204404

Deleted

Request

JavaScriptCurlPython

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

Response

404

{
  "code": "text",
  "message": "text"
}