Add a Tracking Domain

This API lets you add a tracking domain.

Request Type

POST

Request URL

https://campaigns.zoho.com/emailapi/v1/settings/domain/tracking

Content-Type

application/json

List of Request Body Attributes

Parameters	Data Type	Description
tracking_domain	String	Name of the tracking domain.

List of Response Body Attributes

Parameters	Data Type	Description
response	JSON Object	Contains the response details of the API.
code	Integer	Success or failure code.
message	String	Success or failure message returned by the API.
tracking_domain	JSON Array	Contains details of the tracking domain.
verify_status	String	Indicates the status of the tracking domain such as Unauthenticated, Pending, or Authenticated.
is_default	Boolean	Indicates whether this domain is the default one or not.
dns_host_name	String	Host name of the sending domain.
dns_record_type	String	Record type of the sending domain.
dns_value	String	The value which must be added in the DNS.
errors	JSON Array	Contains the error details of the API such as 'code' and 'message'.

Error Codes

Error Code	Description
400101	Domain name not provided.
400104	No such domain configured.
400107	Domain verification failed due to missing public key in DNS.
400111	Invalid tracking domain.
400112	Tracking domain already present.
400113	Tracking domain not verified.
400114	Default tracking domain cannot be deleted. Please mark another domain as default and try deleting.

Sample Request Payload

Copied{
  "tracking_domain": "zylker.in"
}

Sample Response - Success

Copied{
  "response": {
    "code": 200102,
    "message": "Domain added successfully"
  },
  "tracking_domain": {
    "dns_host_name": "zylk2er.com",
    "dns_record_type": "CNAME",
    "dns_value": "campaigns.cs.zohohost.com",
    "verify_status": "Unauthenticated",
    "is_default": false
  }
}

Sample Response - Failure

Copied{
  "errors": [
    {
      "code": 400111,
      "message": "Invalid tracking domain"
    }
  ]
}