Update domain configuration

PUT

/api/domains/{domain}

const url = 'https://smtp-app.kirim.email/api/domains/example.com';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'},
  body: '{"open_track":true,"click_track":true,"unsub_track":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://smtp-app.kirim.email/api/domains/example.com \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "open_track": true, "click_track": true, "unsub_track": true }'

Update tracking settings for a domain

Authorizations

basicAuth

Parameters

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

Domain tracking configuration updates

object

open_track

Enable open tracking

boolean

Example

true

click_track

Enable click tracking

boolean

Example

true

unsub_track

Enable unsubscribe tracking

boolean

Example

true

object

open_track

Enable open tracking

boolean

Example

true

click_track

Enable click tracking

boolean

Example

true

unsub_track

Enable unsubscribe tracking

boolean

Example

true

Responses

200

Domain updated successfully

application/json

object

data

Updated domain tracking configuration

object

open_track

Whether open tracking is enabled for emails sent from this domain

boolean

click_track

Whether click tracking is enabled for emails sent from this domain

boolean

unsub_track

Whether unsubscribe tracking is enabled for emails sent from this domain

boolean

Example

{
  "data": {
    "open_track": true,
    "click_track": true,
    "unsub_track": true
  }
}

401

Unauthorized

application/json

object

error

Error type indicating authentication failure

string

message

Human-readable error message explaining the authentication issue

string

Example

{
  "error": "Unauthorized",
  "message": "Authorization header is required"
}

404

Domain not found

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Domain not found"
}

422

Validation Error

application/json

object

success

Indicates the request failed due to validation errors

boolean

message

Human-readable error message

string

errors

Field-specific validation error messages organized by field name

object

Example

{
  "success": false,
  "message": "Validation failed."
}

429

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

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Too many attempts. Please try again later."
}

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

Server Error

application/json

object

success

Indicates the request failed due to a server error

boolean

message

Human-readable error message describing the server error

string

Example

{
  "success": false,
  "message": "An error occurred while processing the request."
}