Sender Addresses API
API reference for managing sender addresses (From addresses) in Taifa Mail.
Base URL: https://govconnect.ke/v1
All endpoints require authentication via API Key or JWT cookie.
Create a sender address
Registers a new sender address on a verified domain. You can then use this address as the from_ field when sending emails.
Request body:
| Field | Type | Required | Description |
|---|---|---|---|
email | string (email) | Yes | The email address to send from. Must be on a verified domain. |
display_name | string | No | The display name shown to recipients (e.g. "Your Company"). |
domain_id | UUID | Yes | The ID of the verified domain this address belongs to. |
The domain associated with domain_id must have a verified status. Use the Domains API to verify your domain first.
Response (201 Created):
cURL
Python
Node.js
List sender addresses
Returns all sender addresses registered to your account.
Response:
Only active sender addresses are returned.
Python
Node.js
Check a sender address
Checks whether a specific email address exists as a sender address and whether it can currently send emails. This is useful for validating a sender address before attempting to send.
| Parameter | Type | Description |
|---|---|---|
email | string (path) | The email address to check. |
Response:
The can_send field is true only when all of the following are met:
- The sender address exists (
exists: true) - The sender address is active (
active: true) - The associated domain is verified (
domain_verified: true)
Response when address does not exist:
Python
Node.js
Delete a sender address
Permanently removes a sender address. Emails can no longer be sent from this address.
| Parameter | Type | Description |
|---|---|---|
address_id | UUID (path) | The ID of the sender address to delete. |
Response (204 No Content):
No response body.
Python
Node.js
Deleting a sender address is permanent. Any scheduled emails or automations using this address will fail if they have not yet been sent. Update your sending configuration before deleting an address.
Errors
| Status | Description |
|---|---|
400 Bad Request | The associated domain is not verified, or the email's domain does not match the domain record. |
401 Unauthorized | Missing or invalid authentication. |
403 Forbidden | You have reached the sender address limit for your plan. |
404 Not Found | The specified domain or sender address ID does not exist or does not belong to your account. |
409 Conflict | A sender address with this email already exists. |