Skip to main content

Edith Service API

The Edith Service API enables seamless email configuration, sending, receiving, and tracking with high reliability and scalability. Designed for fault tolerance, it ensures smooth email communication by eliminating single points of failure while minimizing operational effort.

Authentication

When registering your service or product with EDITH, you received a bearer token. Use this token for authentication in API requests.

curl --request GET \ --url https://api.sparrowmailer.com/v1/domains --header 'Authorization: Bearer your-edith-access-token'

Region-Specific API Endpoints

To call APIs, use the corresponding URL based on your account’s data center.

RegionAPI URL
UShttps://api.sparrowmailer.com

Response codes

We use the standard HTTP status codes like 2xx for success and 4xx for failure. Refer to the following table for status codes.

Response CodeDescription
200 OKThe request was successfully processed.
202 AcceptedThe request has been accepted for processing, but the operation is not yet complete.
204 No ContentThe server has successfully fulfilled the request and that there is no additional content to send in the response payload body.
400 Bad RequestRequest has missing required parameters or validation errors
401 UnauthorizedThe request lacks valid authentication credentials.
403 ForbiddenThe request is authenticated, but the user does not have permission to access the resource.
404 Not FoundThe requested resource could not be found.
409 ConflictThe request conflicts with an existing resource, such as trying to create a duplicate entry.
422 Unprocessable EntityThe request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server ErrorThe server encountered an unexpected issue that prevented it from fulfilling the request.

Support & Assistance

For any support or configuration assistance, contact the Hygiene team. We can help with:

  • Onboarding your product or service with the EDITH service
  • Adding data center (DC) support
  • Resolving configuration blockers