Management API 2.0.0
Base URL: https://api.sendamatic.net
Authenticating requests
To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".
You can manage your tokens from the Profile menu in the app dashboard.
Delivery score
Receiving a bounce with a reputation_score flag is a strong indicator that you should consider removing the recipient from your lists. But what about recipients with ongoing deliverability problems who don't generate hard bounces?
To uncover these issues, Sendamatic calculates a delivery score by comparing delivery attempts to failures. This helps you pinpoint:
- Abandoned addresses - Consistently over quota, and not accepting mail
- Misconfigured addresses, servers and domains - Constantly rejecting messages due to mail loops and similar issues
- Expired domains - Messages never deliver; they only defer before eventually being discarded
Addresses with delivery scores at or near zero warrant further investigation, as this likely signals an ongoing deliverability issue.
Notes
- Considers address delivery history from the past 30 days
- Scores based solely on your account's own delivery history to each address
- Cached delivery scores may be up to 5 minutes old
- Rate limited to 86,400 API calls per day per account
Get delivery score
GET /v2/delivery_score/{email}
URL parameters
email
string
Email address Example: [email protected]
Responses
200 success
{
"data": {
"attempts": 1439,
"bounces": 1426,
"rejections": 1,
"total_failures": 1427,
"complaints": 0,
"days": 31,
"deferrals": 3,
"deliveries": 1435,
"score": 0.01
}
}
Schema of the response body
{
"type": "object",
"example": {
"data": {
"attempts": 1439,
"bounces": 1426,
"rejections": 1,
"total_failures": 1427,
"complaints": 0,
"days": 31,
"deferrals": 3,
"deliveries": 1435,
"score": 0.01
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"attempts": {
"type": "integer",
"example": 1439,
"description": "The total number of delivery attempts to the address"
},
"bounces": {
"type": "integer",
"example": 1426,
"description": "The number of bounce messages received after delivery"
},
"rejections": {
"type": "integer",
"example": 1,
"description": "Messages not accepted for delivery"
},
"total_failures": {
"type": "integer",
"example": 1427,
"description": "The sum of bounces and rejections"
},
"complaints": {
"type": "integer",
"example": 0,
"description": "The number of abuse complaints received for the address"
},
"days": {
"type": "integer",
"example": 31,
"description": "The number of days the data covers"
},
"deferrals": {
"type": "integer",
"example": 3,
"description": "How many times messages to this address were deferred"
},
"deliveries": {
"type": "integer",
"example": 1435,
"description": "The number of messages accepted by the recipient mail server"
},
"score": {
"type": "number",
"example": 0.01,
"description": "(deliveries - bounces) / attempts"
}
}
}
}
}
400 Invalid email address
Mail credentials
List credentials
GET /v2/mail_credentials
Responses
200 OK
{
"data": [
{
"id": 216,
"name": "Test Rem ducimus.",
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z"
},
{
"id": 217,
"name": "Test Et rem nihil.",
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z"
}
]
}
Schema of the response body
{
"type": "object",
"example": {
"data": [
{
"id": 216,
"name": "Test Rem ducimus.",
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z"
},
{
"id": 217,
"name": "Test Et rem nihil.",
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z"
}
]
},
"properties": {
"data": {
"type": "array",
"example": [
{
"id": 216,
"name": "Test Rem ducimus.",
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z"
},
{
"id": 217,
"name": "Test Et rem nihil.",
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z"
}
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 216
},
"name": {
"type": "string",
"example": "Test Rem ducimus."
},
"created_at": {
"type": "string",
"example": "2024-04-19T11:30:57.000000Z"
},
"updated_at": {
"type": "string",
"example": "2024-04-19T11:30:57.000000Z"
}
}
}
}
}
}
Create a new credential
POST /v2/mail_credentials
Request body
Responses
201 Operation successful
{
"data": {
"id": "123",
"name": "MyApp",
"created_at": "2024-04-19T10:52:11.000000Z",
"updated_at": "2024-04-19T10:52:11.000000Z"
}
}
Schema of the response body
{
"type": "object",
"example": {
"data": {
"id": "123",
"name": "MyApp",
"created_at": "2024-04-19T10:52:11.000000Z",
"updated_at": "2024-04-19T10:52:11.000000Z"
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "123"
},
"name": {
"type": "string",
"example": "MyApp"
},
"created_at": {
"type": "string",
"example": "2024-04-19T10:52:11.000000Z"
},
"updated_at": {
"type": "string",
"example": "2024-04-19T10:52:11.000000Z"
}
}
}
}
}
Update a credential
PUT /v2/mail_credentials/{id}
Request body
Responses
201 Operation successful
{
"data": {
"id": "1",
"name": "MyApp",
"created_at": "2024-04-19T10:52:11.000000Z",
"updated_at": "2024-04-19T10:52:11.000000Z"
}
}
Schema of the response body
{
"type": "object",
"example": {
"data": {
"id": "1",
"name": "MyApp",
"created_at": "2024-04-19T10:52:11.000000Z",
"updated_at": "2024-04-19T10:52:11.000000Z"
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"name": {
"type": "string",
"example": "MyApp"
},
"created_at": {
"type": "string",
"example": "2024-04-19T10:52:11.000000Z"
},
"updated_at": {
"type": "string",
"example": "2024-04-19T10:52:11.000000Z"
}
}
}
}
}
Delete a credential
DELETE /v2/mail_credentials/{id}
URL parameters
id
integer
ID Example: 123
Responses
200 Operation successful
Mail identities
List mail identities
GET /v2/mail_identities
Responses
200 OK
{
"data": [
{
"id": 131,
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z",
"domain_name": "ducimus.example.com",
"dkim_signing_enabled": true,
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_headers": null,
"feedback_webhook_url": null,
"list_unsubscribe_default": true
},
{
"id": 132,
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z",
"domain_name": "nostrum.example.com",
"dkim_signing_enabled": true,
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_headers": null,
"feedback_webhook_url": null,
"list_unsubscribe_default": true
}
]
}
Schema of the response body
{
"type": "object",
"example": {
"data": [
{
"id": 131,
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z",
"domain_name": "ducimus.example.com",
"dkim_signing_enabled": true,
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_headers": null,
"feedback_webhook_url": null,
"list_unsubscribe_default": true
},
{
"id": 132,
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z",
"domain_name": "nostrum.example.com",
"dkim_signing_enabled": true,
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_headers": null,
"feedback_webhook_url": null,
"list_unsubscribe_default": true
}
]
},
"properties": {
"data": {
"type": "array",
"example": [
{
"id": 131,
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z",
"domain_name": "ducimus.example.com",
"dkim_signing_enabled": true,
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_headers": null,
"feedback_webhook_url": null,
"list_unsubscribe_default": true
},
{
"id": 132,
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z",
"domain_name": "nostrum.example.com",
"dkim_signing_enabled": true,
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_headers": null,
"feedback_webhook_url": null,
"list_unsubscribe_default": true
}
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 131
},
"created_at": {
"type": "string",
"example": "2024-04-19T11:30:57.000000Z"
},
"updated_at": {
"type": "string",
"example": "2024-04-19T11:30:57.000000Z"
},
"domain_name": {
"type": "string",
"example": "ducimus.example.com"
},
"dkim_signing_enabled": {
"type": "boolean",
"example": true
},
"bounce_email": {
"type": "string",
"example": "[email protected]"
},
"complaint_email": {
"type": "string",
"example": "[email protected]"
},
"unsubscribe_email": {
"type": "string",
"example": "[email protected]"
},
"feedback_webhook_headers": {
"type": "string",
"example": null
},
"feedback_webhook_url": {
"type": "string",
"example": null
},
"list_unsubscribe_default": {
"type": "boolean",
"example": true
}
}
}
}
}
}
Create a new identity
POST /v2/mail_identities
Request body
{
"domain_name": "aeo",
"mail_credential_ids": [],
"mail_from_domain_name": "=^cvFa$P%.+Fl,BKtWgg>)~m?0UGOz?c]D-`j~mg?)\\8fu5={&/<=-}^\\j<[:e2-Vva62R2NV1>eQ1l1hLFZmzf}k$EMW981c1-%y~HvVv@H.@waQq9MxsY`hJ{e4w7W\\gWR0\\).fDOGaVy;iM%JEbe,fXb])cSb#ov1aj2^kOp}5IlrV}RLF1F>F)%~*ty;{_PM}$mH$^!-ELU8wofzMiEj09-lZ6gUnQzUBmhXMbm5ZinZ7a2d-Ri4Op4a935OAAt<!-.)JvrzeIATsvswUQKLUksxHSiiOfZcQJWjLwKCXSsLJGuDWCbcDKpKGFk$)",
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_url": null,
"feedback_webhook_headers": [
"quo"
],
"dkim_signing_enabled": true,
"list_unsubscribe_default": true
}
Schema of the request body
{
"type": "object",
"properties": {
"domain_name": {
"type": "string",
"description": "Must match the regex /^(?!:\\/\\/)(?=.{1,255}$)((.{1,63}\\.){1,127}(?![0-9]*$)[a-z0-9-]+\\.?)$/. Must not be greater than 253 characters.",
"example": "aeo"
},
"mail_credential_ids": {
"type": "object",
"description": "",
"example": [],
"properties": {}
},
"mail_from_domain_name": {
"type": "string",
"description": "This field is required when mail_from_domain_enabled is 1. Must match the regex /(?=^.{4,253}$)(^((?!-)[a-zA-Z0-9-]{1,63}(?<!-)\\.)+[a-zA-Z]{2,63}$)/.",
"example": "=^cvFa$P%.+Fl,BKtWgg>)~m?0UGOz?c]D-`j~mg?)\\8fu5={&/<=-}^\\j<[:e2-Vva62R2NV1>eQ1l1hLFZmzf}k$EMW981c1-%y~HvVv@H.@waQq9MxsY`hJ{e4w7W\\gWR0\\).fDOGaVy;iM%JEbe,fXb])cSb#ov1aj2^kOp}5IlrV}RLF1F>F)%~*ty;{_PM}$mH$^!-ELU8wofzMiEj09-lZ6gUnQzUBmhXMbm5ZinZ7a2d-Ri4Op4a935OAAt<!-.)JvrzeIATsvswUQKLUksxHSiiOfZcQJWjLwKCXSsLJGuDWCbcDKpKGFk$)"
},
"bounce_email": {
"type": "string",
"description": "Must be a valid email address. This field is required when feedback_webhook_url is not present.",
"example": "[email protected]"
},
"complaint_email": {
"type": "string",
"description": "Must be a valid email address. This field is required when feedback_webhook_url is not present.",
"example": "[email protected]"
},
"unsubscribe_email": {
"type": "string",
"description": "Must be a valid email address. This field is required when feedback_webhook_url is not present.",
"example": "[email protected]"
},
"feedback_webhook_url": {
"type": "string",
"description": "",
"example": null
},
"feedback_webhook_headers": {
"type": "array",
"description": "",
"example": [
"quo"
],
"items": {
"type": "string"
}
},
"dkim_signing_enabled": {
"type": "boolean",
"description": "",
"example": true
},
"list_unsubscribe_default": {
"type": "boolean",
"description": "",
"example": true
}
},
"required": [
"domain_name",
"mail_credential_ids"
]
}
Responses
200 OK
{
"data": {
"id": 134,
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z",
"domain_name": "example.com",
"dkim_signing_enabled": true,
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_headers": null,
"feedback_webhook_url": null,
"list_unsubscribe_default": true,
"mail_credential_ids": [
219
],
"mail_from_domain": {
"domain_name": "foo.example.com",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null,
"dns_records": [
{
"name": "foo.example.com",
"type": "TXT",
"value": "v=spf1 include:spf.smtp.sendamatic.net ~all"
},
{
"name": "foo.example.com",
"type": "MX",
"value": "return.smtp.sendamatic.net"
}
]
},
"dkim_keys": [
{
"alias": "5ec60aa2-9e71-39f2-823d-5641f539b86e._domainkey.example.com",
"target": "5ec60aa2-9e71-39f2-823d-5641f539b86e.",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null
}
]
}
}
Schema of the response body
{
"type": "object",
"example": {
"data": {
"id": 134,
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z",
"domain_name": "example.com",
"dkim_signing_enabled": true,
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_headers": null,
"feedback_webhook_url": null,
"list_unsubscribe_default": true,
"mail_credential_ids": [
219
],
"mail_from_domain": {
"domain_name": "foo.example.com",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null,
"dns_records": [
{
"name": "foo.example.com",
"type": "TXT",
"value": "v=spf1 include:spf.smtp.sendamatic.net ~all"
},
{
"name": "foo.example.com",
"type": "MX",
"value": "return.smtp.sendamatic.net"
}
]
},
"dkim_keys": [
{
"alias": "5ec60aa2-9e71-39f2-823d-5641f539b86e._domainkey.example.com",
"target": "5ec60aa2-9e71-39f2-823d-5641f539b86e.",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null
}
]
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 134
},
"created_at": {
"type": "string",
"example": "2024-04-19T11:30:57.000000Z"
},
"updated_at": {
"type": "string",
"example": "2024-04-19T11:30:57.000000Z"
},
"domain_name": {
"type": "string",
"example": "example.com"
},
"dkim_signing_enabled": {
"type": "boolean",
"example": true
},
"bounce_email": {
"type": "string",
"example": "[email protected]"
},
"complaint_email": {
"type": "string",
"example": "[email protected]"
},
"unsubscribe_email": {
"type": "string",
"example": "[email protected]"
},
"feedback_webhook_headers": {
"type": "string",
"example": null
},
"feedback_webhook_url": {
"type": "string",
"example": null
},
"list_unsubscribe_default": {
"type": "boolean",
"example": true
},
"mail_credential_ids": {
"type": "array",
"example": [
219
],
"items": {
"type": "integer"
}
},
"mail_from_domain": {
"type": "object",
"properties": {
"domain_name": {
"type": "string",
"example": "foo.example.com"
},
"verification_status_text": {
"type": "string",
"example": "new"
},
"is_verified": {
"type": "boolean",
"example": false
},
"verified_at": {
"type": "string",
"example": null
},
"dns_records": {
"type": "array",
"example": [
{
"name": "foo.example.com",
"type": "TXT",
"value": "v=spf1 include:spf.smtp.sendamatic.net ~all"
},
{
"name": "foo.example.com",
"type": "MX",
"value": "return.smtp.sendamatic.net"
}
],
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "foo.example.com"
},
"type": {
"type": "string",
"example": "TXT"
},
"value": {
"type": "string",
"example": "v=spf1 include:spf.smtp.sendamatic.net ~all"
}
}
}
}
}
},
"dkim_keys": {
"type": "array",
"example": [
{
"alias": "5ec60aa2-9e71-39f2-823d-5641f539b86e._domainkey.example.com",
"target": "5ec60aa2-9e71-39f2-823d-5641f539b86e.",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null
}
],
"items": {
"type": "object",
"properties": {
"alias": {
"type": "string",
"example": "5ec60aa2-9e71-39f2-823d-5641f539b86e._domainkey.example.com"
},
"target": {
"type": "string",
"example": "5ec60aa2-9e71-39f2-823d-5641f539b86e."
},
"verification_status_text": {
"type": "string",
"example": "new"
},
"is_verified": {
"type": "boolean",
"example": false
},
"verified_at": {
"type": "string",
"example": null
}
}
}
}
}
}
}
}
Get an identity
GET /v2/mail_identities/{id}
URL parameters
id
integer
ID Example: 123
Responses
200 OK
{
"data": {
"id": 133,
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z",
"domain_name": "labore.example.com",
"dkim_signing_enabled": true,
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_headers": null,
"feedback_webhook_url": null,
"list_unsubscribe_default": true,
"mail_credential_ids": [
218
],
"mail_from_domain": {
"domain_name": "foo.labore.example.com",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null,
"dns_records": [
{
"name": "foo.labore.example.com",
"type": "TXT",
"value": "v=spf1 include:spf.smtp.sendamatic.net ~all"
},
{
"name": "foo.labore.example.com",
"type": "MX",
"value": "return.smtp.sendamatic.net"
}
]
},
"dkim_keys": [
{
"alias": "3cef07c3-fcee-39e5-be38-0b2121f8cae7._domainkey.labore.example.com",
"target": "3cef07c3-fcee-39e5-be38-0b2121f8cae7.",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null
}
]
}
}
Schema of the response body
{
"type": "object",
"example": {
"data": {
"id": 133,
"created_at": "2024-04-19T11:30:57.000000Z",
"updated_at": "2024-04-19T11:30:57.000000Z",
"domain_name": "labore.example.com",
"dkim_signing_enabled": true,
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_headers": null,
"feedback_webhook_url": null,
"list_unsubscribe_default": true,
"mail_credential_ids": [
218
],
"mail_from_domain": {
"domain_name": "foo.labore.example.com",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null,
"dns_records": [
{
"name": "foo.labore.example.com",
"type": "TXT",
"value": "v=spf1 include:spf.smtp.sendamatic.net ~all"
},
{
"name": "foo.labore.example.com",
"type": "MX",
"value": "return.smtp.sendamatic.net"
}
],
},
"dkim_keys": [
{
"alias": "3cef07c3-fcee-39e5-be38-0b2121f8cae7._domainkey.labore.example.com",
"target": "3cef07c3-fcee-39e5-be38-0b2121f8cae7.",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null
}
]
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 133
},
"created_at": {
"type": "string",
"example": "2024-04-19T11:30:57.000000Z"
},
"updated_at": {
"type": "string",
"example": "2024-04-19T11:30:57.000000Z"
},
"domain_name": {
"type": "string",
"example": "labore.example.com"
},
"dkim_signing_enabled": {
"type": "boolean",
"example": true
},
"bounce_email": {
"type": "string",
"example": "[email protected]"
},
"complaint_email": {
"type": "string",
"example": "[email protected]"
},
"unsubscribe_email": {
"type": "string",
"example": "[email protected]"
},
"feedback_webhook_headers": {
"type": "string",
"example": null
},
"feedback_webhook_url": {
"type": "string",
"example": null
},
"list_unsubscribe_default": {
"type": "boolean",
"example": true
},
"mail_credential_ids": {
"type": "array",
"example": [
218
],
"items": {
"type": "integer"
}
},
"mail_from_domain": {
"type": "object",
"properties": {
"domain_name": {
"type": "string",
"example": "foo.labore.example.com"
},
"verification_status_text": {
"type": "string",
"example": "new"
},
"is_verified": {
"type": "boolean",
"example": false
},
"verified_at": {
"type": "string",
"example": null
},
"dns_records": {
"type": "array",
"example": [
{
"name": "foo.labore.example.com",
"type": "TXT",
"value": "v=spf1 include:spf.smtp.sendamatic.net ~all"
},
{
"name": "foo.labore.example.com",
"type": "MX",
"value": "return.smtp.sendamatic.net"
}
],
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "foo.labore.example.com"
},
"type": {
"type": "string",
"example": "TXT"
},
"value": {
"type": "string",
"example": "v=spf1 include:spf.smtp.sendamatic.net ~all"
}
}
}
}
}
},
"dkim_keys": {
"type": "array",
"example": [
{
"alias": "3cef07c3-fcee-39e5-be38-0b2121f8cae7._domainkey.labore.example.com",
"target": "3cef07c3-fcee-39e5-be38-0b2121f8cae7.",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null
}
],
"items": {
"type": "object",
"properties": {
"alias": {
"type": "string",
"example": "3cef07c3-fcee-39e5-be38-0b2121f8cae7._domainkey.labore.example.com"
},
"target": {
"type": "string",
"example": "3cef07c3-fcee-39e5-be38-0b2121f8cae7."
},
"verification_status_text": {
"type": "string",
"example": "new"
},
"is_verified": {
"type": "boolean",
"example": false
},
"verified_at": {
"type": "string",
"example": null
}
}
}
}
}
}
}
}
Update an identity
PUT /v2/mail_identities/{id}
URL parameters
id
integer
ID Example: 123
Request body
{
"mail_credential_ids": [],
"mail_from_domain_name": "=^T%t$p8C_)Tmc8n%9<#c;Ftch`c+\"@v<i+64pM=*wu$aEqY~GFJVE@0G=nA'\\%k[JS5l[dpKx!_kj<_7?9*)c%(u7{Hs_3P@6!w>GH5jFM>!NpFk~*yUms~qZvK7|DVoBFKm4#do\\H<Y_>Z]6;\\RztDc{K9@L@=D51K%L(@DM]0z{ZmO*+l*FVbB_z|K^W&H}ecyV:3jc[pZeQCVI|C%5542hH<a$)^!-UPdIgbBnag1QvSaNvSX3xM-fnYQi-FMwuGLAeC6n6d1OX2SoUN-hKdzNaXY-m<!-).)cyVJmPTKfl$)",
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_url": null,
"feedback_webhook_headers": [
"ab"
]
}
Schema of the request body
{
"type": "object",
"properties": {
"mail_credential_ids": {
"type": "object",
"description": "",
"example": [],
"properties": {}
},
"mail_from_domain_name": {
"type": "string",
"description": "This field is required when mail_from_domain_enabled is 1. Must match the regex /(?=^.{4,253}$)(^((?!-)[a-zA-Z0-9-]{1,63}(?<!-)\\.)+[a-zA-Z]{2,63}$)/.",
"example": "=^T%t$p8C_)Tmc8n%9<#c;Ftch`c+\"@v<i+64pM=*wu$aEqY~GFJVE@0G=nA'\\%k[JS5l[dpKx!_kj<_7?9*)c%(u7{Hs_3P@6!w>GH5jFM>!NpFk~*yUms~qZvK7|DVoBFKm4#do\\H<Y_>Z]6;\\RztDc{K9@L@=D51K%L(@DM]0z{ZmO*+l*FVbB_z|K^W&H}ecyV:3jc[pZeQCVI|C%5542hH<a$)^!-UPdIgbBnag1QvSaNvSX3xM-fnYQi-FMwuGLAeC6n6d1OX2SoUN-hKdzNaXY-m<!-).)cyVJmPTKfl$)"
},
"bounce_email": {
"type": "string",
"description": "Must be a valid email address.",
"example": "[email protected]"
},
"complaint_email": {
"type": "string",
"description": "Must be a valid email address.",
"example": "[email protected]"
},
"unsubscribe_email": {
"type": "string",
"description": "Must be a valid email address.",
"example": "[email protected]"
},
"feedback_webhook_url": {
"type": "string",
"description": "",
"example": null
},
"feedback_webhook_headers": {
"type": "array",
"description": "",
"example": [
"ab"
],
"items": {
"type": "string"
}
}
},
"required": [
"mail_credential_ids"
]
}
Responses
200 OK
{
"data": {
"id": 135,
"created_at": "2024-04-19T11:30:58.000000Z",
"updated_at": "2024-04-19T11:30:58.000000Z",
"domain_name": "beatae.example.com",
"dkim_signing_enabled": true,
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_headers": null,
"feedback_webhook_url": null,
"list_unsubscribe_default": true,
"mail_credential_ids": [
220
],
"mail_from_domain": {
"domain_name": "foo.beatae.example.com",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null,
"dns_records": [
{
"name": "foo.beatae.example.com",
"type": "TXT",
"value": "v=spf1 include:spf.smtp.sendamatic.net ~all"
},
{
"name": "foo.beatae.example.com",
"type": "MX",
"value": "return.smtp.sendamatic.net"
}
],
},
"dkim_keys": [
{
"alias": "f4622c1d-c665-3437-a6f1-091733315603._domainkey.beatae.example.com",
"target": "f4622c1d-c665-3437-a6f1-091733315603.",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null
}
]
}
}
Schema of the response body
{
"type": "object",
"example": {
"data": {
"id": 135,
"created_at": "2024-04-19T11:30:58.000000Z",
"updated_at": "2024-04-19T11:30:58.000000Z",
"domain_name": "beatae.example.com",
"dkim_signing_enabled": true,
"bounce_email": "[email protected]",
"complaint_email": "[email protected]",
"unsubscribe_email": "[email protected]",
"feedback_webhook_headers": null,
"feedback_webhook_url": null,
"list_unsubscribe_default": true,
"mail_credential_ids": [
220
],
"mail_from_domain": {
"domain_name": "foo.beatae.example.com",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null,
"dns_records": [
{
"name": "foo.beatae.example.com",
"type": "TXT",
"value": "v=spf1 include:spf.smtp.sendamatic.net ~all"
},
{
"name": "foo.beatae.example.com",
"type": "MX",
"value": "return.smtp.sendamatic.net"
}
],
},
"dkim_keys": [
{
"alias": "f4622c1d-c665-3437-a6f1-091733315603._domainkey.beatae.example.com",
"target": "f4622c1d-c665-3437-a6f1-091733315603.",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null
}
]
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 135
},
"created_at": {
"type": "string",
"example": "2024-04-19T11:30:58.000000Z"
},
"updated_at": {
"type": "string",
"example": "2024-04-19T11:30:58.000000Z"
},
"domain_name": {
"type": "string",
"example": "beatae.example.com"
},
"dkim_signing_enabled": {
"type": "boolean",
"example": true
},
"bounce_email": {
"type": "string",
"example": "[email protected]"
},
"complaint_email": {
"type": "string",
"example": "[email protected]"
},
"unsubscribe_email": {
"type": "string",
"example": "[email protected]"
},
"feedback_webhook_headers": {
"type": "string",
"example": null
},
"feedback_webhook_url": {
"type": "string",
"example": null
},
"list_unsubscribe_default": {
"type": "boolean",
"example": true
},
"mail_credential_ids": {
"type": "array",
"example": [
220
],
"items": {
"type": "integer"
}
},
"mail_from_domain": {
"type": "object",
"properties": {
"domain_name": {
"type": "string",
"example": "foo.beatae.example.com"
},
"verification_status_text": {
"type": "string",
"example": "new"
},
"is_verified": {
"type": "boolean",
"example": false
},
"verified_at": {
"type": "string",
"example": null
},
"dns_records": {
"type": "array",
"example": [
{
"name": "foo.beatae.example.com",
"type": "TXT",
"value": "v=spf1 include:spf.smtp.sendamatic.net ~all"
},
{
"name": "foo.beatae.example.com",
"type": "MX",
"value": "return.smtp.sendamatic.net"
}
],
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "foo.beatae.example.com"
},
"type": {
"type": "string",
"example": "TXT"
},
"value": {
"type": "string",
"example": "v=spf1 include:spf.smtp.sendamatic.net ~all"
}
}
}
}
}
},
"dkim_keys": {
"type": "array",
"example": [
{
"alias": "f4622c1d-c665-3437-a6f1-091733315603._domainkey.beatae.example.com",
"target": "f4622c1d-c665-3437-a6f1-091733315603.",
"verification_status_text": "new",
"is_verified": false,
"verified_at": null
}
],
"items": {
"type": "object",
"properties": {
"alias": {
"type": "string",
"example": "f4622c1d-c665-3437-a6f1-091733315603._domainkey.beatae.example.com"
},
"target": {
"type": "string",
"example": "f4622c1d-c665-3437-a6f1-091733315603."
},
"verification_status_text": {
"type": "string",
"example": "new"
},
"is_verified": {
"type": "boolean",
"example": false
},
"verified_at": {
"type": "string",
"example": null
}
}
}
}
}
}
}
}
Delete an identity
DELETE /v2/mail_identities/{id}
URL parameters
id
integer
ID Example: 123
Responses
200 OK
Verified emails
List verified emails
GET /v2/verified_emails
Responses
200 OK
{
"data": [
{
"created_at": "2024-04-16T12:20:15.000000Z",
"email": "[email protected]"
},
{
"created_at": "2024-04-16T12:20:15.000000Z",
"email": "[email protected]"
}
]
}
Schema of the response body
{
"type": "object",
"example": {
"data": [
{
"created_at": "2024-04-16T12:20:15.000000Z",
"email": "[email protected]"
},
{
"created_at": "2024-04-16T12:20:15.000000Z",
"email": "[email protected]"
}
]
},
"properties": {
"data": {
"type": "array",
"example": [
{
"created_at": "2024-04-16T12:20:15.000000Z",
"email": "[email protected]"
},
{
"created_at": "2024-04-16T12:20:15.000000Z",
"email": "[email protected]"
}
],
"items": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"example": "2024-04-16T12:20:15.000000Z"
},
"email": {
"type": "string",
"example": "[email protected]"
}
}
}
}
}
}
Create a new verified address request
POST /v2/verified_emails
Request body
{
"email": "[email protected]"
}
Schema of the request body
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email address",
"example": "[email protected]"
}
},
"required": [
"email"
]
}
Responses
201 Operation successful
Remove a verified email
DELETE /v2/verified_emails/{email}
URL parameters
email
string
Email address Example: [email protected]
Responses