Update tracking events
API to update tracking events for the provided domain. Tracking events can be updated only for CLICKS, OPENS and UNSUBSCRIBES.
Please log in to see full path URL. Learn why.
put
/email/1/domains/{domainName}/tracking
Authorizations:
Scopes:
Request rate limit:
1000 requests / second (per account)
path Parameters
domainName required | string Domain for which the tracking events need to be updated. |
Request Body schema:
application/jsoncollapse all -
open | boolean Boolean value corresponding to whether opens for a message needs to be tracked or not. |
clicks | boolean Boolean value corresponding to whether clicks for a message needs to be tracked or not. |
unsubscribe | boolean Boolean value corresponding to whether unsubscribe for a message needs to be tracked or not. |
Responses
200
OK
400
Bad Request.
401
Unauthorized
403
Forbidden
404
Requested domain does not exist.
429
Too Many Requests
500
Internal Server Error
Request samples
- Payload
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
Content type
application/json
Copy
Collapse all {- "open": true,
- "clicks": true,
- "unsubscribe": false
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
- 500
Content type
application/json
Copy
Collapse all {- "domainId": 1,
- "domainName": "example.com",
- "active": false,
- "tracking": {
- "clicks": true,
- "opens": true,
- "unsubscribe": true
}, - "dnsRecords": [
- {
- "recordType": "string",
- "name": "string",
- "expectedValue": "string",
- "verified": true
}
], - "blocked": false,
- "createdAt": "2021-01-02T01:00:00.123Z",
- "returnPathAddress": "returnpath@example.com"
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See