Skip to content
Kirim.Email SMTP API

Setup authentication domain

POST
/api/domains/{domain}/setup-auth-domain

Configure an authentication domain for a domain

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
domain
required
string
Example
example.com

Domain 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
auth_domain

Authentication domain

string
Example
auth.example.com
dkim_key_length
required

DKIM key length

integer
Allowed values: 1024 2048
Example
2048

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Authentication domain setup successfully

object
data

Authentication domain configuration

object
auth_domain

The authentication domain that was successfully configured for DKIM and email authentication

string
Example
auth.example.com

401

Section titled “401 ”

Unauthorized

object
error

Error type indicating authentication failure

string
Example
Unauthorized
message

Human-readable error message explaining the authentication issue

string
Example
Authorization header is required

404

Section titled “404 ”

Domain not found

object
success
boolean
message
string
Example
Domain not found

422

Section titled “422 ”

Validation Error

object
success

Indicates the request failed due to validation errors

boolean
message

Human-readable error message

string
Example
Validation failed.
errors

Field-specific validation error messages organized by field name

object

429

Section titled “429 ”

Too Many Requests - Rate limit exceeded. Retry after the specified time.

object
success
boolean
message
string
Example
Too many attempts. Please try again later.

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until rate limit resets

X-RateLimit-Limit
integer

Maximum requests per minute

X-RateLimit-Remaining
integer

Remaining requests in current window

500

Section titled “500 ”

Server Error

object
success

Indicates the request failed due to a server error

boolean
message

Human-readable error message describing the server error

string
Example
An error occurred while processing the request.