Email
Retrieve a single email
GET
Returns the delivery status and details of a single email owned by the authenticated user.
apiKeyAuthheader
X-Api-Key<token>Your API key, sent as X-Api-Key. Format bsk_<key_id>.<secret>. Create one in the dashboard under Settings → Developer tools.
id*stringA UUID string identifying this Email Message.
Format
uuidEmail retrieved successfully.
application/json- response
id*stringFormat
uuidtraffic_class?stringEmail is transactional only (receipts, codes, alerts) and needs approval. See GET /sending-profile.
promotional- Promotionaltransactional- Transactional
Default
"transactional"Value in
"promotional""transactional"recipient*stringprice*stringcurrency*|The currency of the email
batch_id*|The send this email was part of
Format
uuidmessage_id*|The provider's request id for this send
response_code*|The response code from the delivery
response_description*|The response description from the delivery
status*stringDispatch status of the email
pending- Pendingsent- Sentdelivered- Deliveredbounced- Bouncedfailed- Failedretrying- Retrying
Value in
"pending""sent""delivered""bounced""failed""retrying"created_at*stringFormat
date-timeExample Request
curl -X GET 'https://api.softlinksms.co.ke/api/v1/email/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "traffic_class": "promotional", "recipient": "string", "price": "string", "currency": "string", "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "message_id": "string", "response_code": 0, "response_description": "string", "status": "pending", "created_at": "2019-08-24T14:15:22Z"}