Sender Profiles
Last updated
Was this helpful?
Last updated
Was this helpful?
Retrieve information about a specific sender profile, including its name, and other attributes.
Sender Profile UUID
GET /workspaces/{workspaceId}/sender-profiles/{senderProfileId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "text",
"name": "text",
"email": {
"username": "text",
"domain": "text"
},
"allowedEntities": [
{
"entityType": "team",
"operation": "view",
"entityId": "text"
}
],
"channelId": "text",
"signature": "text",
"createdAt": "2025-06-20T17:18:45.005Z",
"updatedAt": "2025-06-20T17:18:45.005Z"
}Remove a specific sender profile.
Sender Profile UUID
DELETE /workspaces/{workspaceId}/sender-profiles/{senderProfileId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
Retrieve a list of variables to use for signature configuration in sender profile.
GET /workspaces/{workspaceId}/sender-profiles/signature-variables HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "text",
"name": "text",
"defaultDescription": "text",
"variable": "text",
"category": "text",
"replacementAttribute": "text",
"langDescription": {}
}
]
}Retrieve a list of sender profiles associated with a user.
Filter by channelId
GET /workspaces/{workspaceId}/users/{userId}/sender-profiles HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "text",
"name": "text",
"email": {
"username": "text",
"domain": "text"
},
"allowedEntities": [
{
"entityType": "team",
"operation": "view",
"entityId": "text"
}
],
"channelId": "text",
"signature": "text",
"createdAt": "2025-06-20T17:18:45.005Z",
"updatedAt": "2025-06-20T17:18:45.005Z"
}
]
}Retrieve a list of sender profiles associated with the account
Limits the number of results to return
10Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
falseGET /workspaces/{workspaceId}/sender-profiles HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "text",
"name": "text",
"email": {
"username": "text",
"domain": "text"
},
"allowedEntities": [
{
"entityType": "team",
"operation": "view",
"entityId": "text"
}
],
"channelId": "text",
"signature": "text",
"createdAt": "2025-06-20T17:18:45.005Z",
"updatedAt": "2025-06-20T17:18:45.005Z"
}
]
}Create a new sender profile, defining its name, and other attributes.
POST /workspaces/{workspaceId}/sender-profiles HTTP/1.1
Host:
Authorization: Bearer jwt
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
Modify the details of a specific sender profile, such as its name or other attributes.
Sender Profile UUID
PATCH /workspaces/{workspaceId}/sender-profiles/{senderProfileId} HTTP/1.1
Host:
Authorization: Bearer jwt
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-06-20T17:18:45.005Z",
"updatedAt": "2025-06-20T17:18:45.005Z"
}