Setup tracking domain
const url = 'https://smtp-app.kirim.email/api/domains/example.com/setup-tracklink';const options = { method: 'POST', headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'}, body: '{"tracking_domain":"track.example.com"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://smtp-app.kirim.email/api/domains/example.com/setup-tracklink \ --header 'Authorization: Basic <credentials>' \ --header 'Content-Type: application/json' \ --data '{ "tracking_domain": "track.example.com" }'Configure a tracking domain for click and open tracking
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Example
example.comDomain name that must be owned by the authenticated user. The domain must be verified and properly configured for email sending.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Tracking domain for click and open tracking
Example
track.example.comResponses
Section titled “Responses”Tracking domain setup successfully
object
Tracking domain configuration
object
The tracking domain that was successfully configured for click and open tracking
Example
{ "data": { "tracking_domain": "track.example.com" }}Unauthorized
object
Error type indicating authentication failure
Human-readable error message explaining the authentication issue
Example
{ "error": "Unauthorized", "message": "Authorization header is required"}Domain not found
object
Example
{ "success": false, "message": "Domain not found"}Validation Error
object
Indicates the request failed due to validation errors
Human-readable error message
Field-specific validation error messages organized by field name
object
Example
{ "success": false, "message": "Validation failed."}Too Many Requests - Rate limit exceeded. Retry after the specified time.
object
Example
{ "success": false, "message": "Too many attempts. Please try again later."}Headers
Section titled “Headers”Seconds until rate limit resets
Maximum requests per minute
Remaining requests in current window
Server Error
object
Indicates the request failed due to a server error
Human-readable error message describing the server error
Example
{ "success": false, "message": "An error occurred while processing the request."}