Setup tracking domain
POST /api/domains/{domain}/setup-tracklink
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 Body required
Section titled “Request Body required ”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
track.example.comUnauthorized
object
Error type indicating authentication failure
Example
UnauthorizedHuman-readable error message explaining the authentication issue
Example
Authorization header is requiredDomain not found
object
Example
Domain not foundValidation Error
object
Indicates the request failed due to validation errors
Human-readable error message
Example
Validation failed.Field-specific validation error messages organized by field name
object
Too Many Requests - Rate limit exceeded. Retry after the specified time.
object
Example
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
An error occurred while processing the request.