Senders

5 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
name	string	optional
fromEmail	string (email)	optional
fromName	string	optional
replyToEmail	string (email)	optional
provider	string	optional
providerSenderId	string	optional
priority	number	optional
isDefault	boolean	optional

Responses

200The updated sender

Field	Type	Required
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

List 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

Responses

200Paginated list of senders

Field	Type	Required	Description
data	object[]	required
pagination	object	required

500Internal server error

Field	Type	Required	Description
error	string	required

POST/api/senders

Create sender

Create a new sender identity for outbound email.

Request Bodyrequired

Field	Type	Required
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

Responses

200The created sender

Field	Type	Required
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

POST/api/senders/select

Select 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
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