SonarSend API Endpoints Reference data

Reference data

Email types, MTA configs and identities, addressed by public key.

3 endpoints Base URL · https://api.sonarsend.com Auth · X-API-Key
The SendingIdentity object 15 fields
activeboolean
content_rewrite_domainstring · nullable
created_atdate-time
default_mta_config_iduuid · nullable

The identity's default verified sending lane's MTA, when one is set.

display_namestring · nullable
email_addressstring

The from-address. This is the value broadcasts reference in sending_identity_emails.

email_type_idsuuid[]

The email types this identity may send. Many-to-many: an identity can serve several types.

iduuid
image_rewrite_domainstring · nullable
reply_tostring · nullable
sending_domain_iduuid

The domain the address belongs to.

tenant_iduuid
tracking_domainstring · nullable

The domain links and the open pixel are rewritten to. Null until tracking is configured — sending is hard-gated on a live tracking domain.

utm_codestring · nullable
verified_mta_config_idsuuid[]

MTAs whose (identity × MTA) lane has been confirmed by a test-send and may send.

The EmailType object 11 fields
activeboolean
category_iduuid · nullable

Owning email category, when categorised; null otherwise.

created_atdate-time
descriptionstring · nullable
display_namestring
iduuid
list_id_enabledboolean

Whether a List-ID header is emitted for sends of this type.

sort_orderinteger
tenant_iduuid
type_keystring

Stable public key. This is the value broadcasts reference as email_type_key.

utm_campaign_prefixstring · nullable

Prepended to the utm_campaign on tracked links for sends of this type.

List sending identities

GET /t/{slug}/api/sending-identities/

Every configured from-address in the workspace. Reference one in a broadcast payload by its email_address (sending_identity_emails). Each row also carries the email types it can send (email_type_ids) and its verified sending lanes (verified_mta_config_ids, default_mta_config_id). Not paginated.

Returns

A page of SendingIdentity objects, under data.

SendingIdentity 15 fields
Responses
200

Every sending identity.
400

The request failed validation, or a referenced record was rejected.
404

The tenant slug, or the record the path names, does not exist.
Request 
curl -X GET "https://api.sonarsend.com/t/acme/api/sending-identities" \
  -H "X-API-Key: $SONARSEND_API_KEY"
Response 200 
{
  "data": [
    {
      "id": "9c21895d-57f0-4a15-a1df-4dc6835d4f80",
      "tenant_id": "9c21895d-57f0-4a15-a1df-4dc6835d4f80",
      "email_address": "string",
      "display_name": "Acme onboarding",
      "reply_to": "string",
      "email_type_ids": [
        "9c21895d-57f0-4a15-a1df-4dc6835d4f80"
      ]
    }
  ],
  "next_cursor": "eyJpZCI6IjljMjE4OTVkIn0",
  "has_more": true
}

Get a sending identity

GET /t/{slug}/api/sending-identities/{id}

One sending identity by its UUID.

Path parameters
id string Required
Returns

The SendingIdentity object.

SendingIdentity 15 fields
Responses
200

The sending identity.
400

The request failed validation, or a referenced record was rejected.
404

The tenant slug, or the record the path names, does not exist.
Request 
curl -X GET "https://api.sonarsend.com/t/acme/api/sending-identities/9c21895d-57f0-4a15-a1df-4dc6835d4f80" \
  -H "X-API-Key: $SONARSEND_API_KEY"
Response 200 
{
  "id": "9c21895d-57f0-4a15-a1df-4dc6835d4f80",
  "tenant_id": "9c21895d-57f0-4a15-a1df-4dc6835d4f80",
  "email_address": "string",
  "display_name": "Acme onboarding",
  "reply_to": "string",
  "email_type_ids": [
    "9c21895d-57f0-4a15-a1df-4dc6835d4f80"
  ]
}

List email types

GET /t/{slug}/api/email-types/

Every sending category in the workspace. Use a type's type_key as email_type_key in a broadcast payload. Read this before creating a broadcast. Not paginated.

Returns

A page of EmailType objects, under data.

EmailType 11 fields
Responses
200

Every email type.
400

The request failed validation, or a referenced record was rejected.
404

The tenant slug, or the record the path names, does not exist.
Request 
curl -X GET "https://api.sonarsend.com/t/acme/api/email-types" \
  -H "X-API-Key: $SONARSEND_API_KEY"
Response 200 
{
  "data": [
    {
      "id": "9c21895d-57f0-4a15-a1df-4dc6835d4f80",
      "tenant_id": "9c21895d-57f0-4a15-a1df-4dc6835d4f80",
      "type_key": "welcome-series",
      "display_name": "Acme onboarding",
      "description": "string",
      "utm_campaign_prefix": "string"
    }
  ],
  "next_cursor": "eyJpZCI6IjljMjE4OTVkIn0",
  "has_more": true
}