ClientSphereDocs
API reference/Transactional Email

Get a transactional message's delivery status

Poll this after sending to follow a message from sent through delivered, bounced or complained. Message content is not returned.

GET
/transactional/messages/{id}

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token: Authorization: Bearer sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

X-API-Key<token>

API key via header: X-API-Key: sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

Path Parameters

idRequiredstring

Message id returned by the send call

Format: "uuid"
curl -X GET "https://clientsphere.io/api/v1/transactional/messages/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"

The message

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "status": "rejected",
    "to": "user@example.com",
    "subject": "string",
    "templateSlug": "string",
    "from": "user@example.com",
    "fromName": "string",
    "replyTo": "string",
    "messageId": "string",
    "idempotencyKey": "string",
    "source": "api",
    "attemptCount": 0,
    "error": "string",
    "errorReason": "string",
    "bounceType": "Permanent",
    "createdAt": "2019-08-24T14:15:22Z",
    "sentAt": "2019-08-24T14:15:22Z",
    "deliveredAt": "2019-08-24T14:15:22Z",
    "bouncedAt": "2019-08-24T14:15:22Z",
    "complainedAt": "2019-08-24T14:15:22Z"
  }
}

Previous

List transactional messages GET

Next

Send a transactional email POST