Senders
6 endpoints
PUT
/api/senders/{id}Update sender
Update an existing sender identity. All fields are optional.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string (uuid) | required | Sender ID |
Request Bodyrequired
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | optional | |
| fromEmail | string (email) | optional | |
| fromName | any | optional | |
| replyToEmail | any | optional | |
| provider | any | optional | |
| providerSenderId | string | optional | |
| priority | number | optional | |
| isDefault | boolean | optional | |
| isActive | boolean | optional |
Responses
200The updated sender
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | required | |
| name | string | required | |
| fromEmail | string | required | |
| fromName | any | required | |
| replyToEmail | any | required | |
| provider | any | required | |
| providerSenderId | any | required | |
| priority | any | required | |
| isDefault | any | required | |
| isActive | any | required | |
| isVerified | any | required | |
| verificationStatus | any | required | |
| createdAt | string | required | |
| updatedAt | string | required |
400Validation error
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |
500Internal server error
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |
DELETE
/api/senders/{id}Delete sender
Remove a sender identity.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string (uuid) | required | Sender ID |
Responses
200Sender deleted
| Field | Type | Required | Description |
|---|---|---|---|
| deleted | boolean | required |
500Internal server error
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |
GET
/api/senders/domainsList sender domains
The project's verified sending domains. A sender's From address must use one of them.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | query | string (uuid) | optional | Project to list; omitted = the org's only project |
Responses
200Verified sending domains, lowercased
| Field | Type | Required | Description |
|---|---|---|---|
| domains | string[] | required |
404Project not found
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |
500Internal server error
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |
GET
/api/sendersList senders
Retrieve a paginated list of all configured sender identities.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | integer | optional | Page number (default 1) |
| limit | query | integer | optional | Items per page (default 25, max 100) |
| search | query | string | optional | Search filter |
| sort | query | string | optional | Sort field |
| order | query | string | optional | Sort order |
| projectId | query | string (uuid) | optional | The project whose senders to list. Omit only when the organization has one project; otherwise 400 PROJECT_REQUIRED. A project you cannot open is 404. |
Responses
200Paginated list of senders
| Field | Type | Required | Description |
|---|---|---|---|
| data | object[] | required | |
| pagination | object | required |
400PROJECT_REQUIRED — the organization has several projects and no projectId was given
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |
404projectId is not a project the caller can open
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |
500Internal server error
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |
POST
/api/sendersCreate sender
Create a new sender identity for outbound email.
Request Bodyrequired
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | required | |
| fromEmail | string (email) | required | |
| fromName | string | optional | |
| replyToEmail | string (email) | optional | |
| provider | string | optional | |
| providerSenderId | string | optional | |
| priority | number | optional | |
| isDefault | boolean | optional | |
| projectId | string (uuid) | optional |
Responses
200The created sender
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | required | |
| name | string | required | |
| fromEmail | string | required | |
| fromName | any | required | |
| replyToEmail | any | required | |
| provider | any | required | |
| providerSenderId | any | required | |
| priority | any | required | |
| isDefault | any | required | |
| isActive | any | required | |
| isVerified | any | required | |
| verificationStatus | any | required | |
| createdAt | string | required | |
| updatedAt | string | required |
400Validation error, or PROJECT_REQUIRED — the organization has several projects and no projectId was given
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |
404projectId is not a project the caller can open
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |
422NO_PROJECT — the organization has no project yet
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |
500Internal server error
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |
POST
/api/senders/selectSelect best sender
Choose the optimal sender identity for a given recipient domain and selection strategy.
Request Bodyrequired
| Field | Type | Required | Description |
|---|---|---|---|
| recipientDomain | string | required | |
| strategy | string | required | ("priority" | "round-robin" | "default")default: "priority" |
Responses
200Best sender result with strategy explanation
| Field | Type | Required | Description |
|---|---|---|---|
| sender | any | required | |
| strategy | string | required | |
| reason | string | required |
400Validation error
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |
500Internal server error
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | required |