> For the complete documentation index, see [llms.txt](https://docs.mailtrap.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mailtrap.io/developers/email-sending/tracking-opt-outs.md).
# Tracking Opt-Outs
Manage email addresses that have opted out of open and click tracking. Tracking opt-outs are always scoped to a sending domain.
## List tracking opt-outs
> List email addresses that have opted out of open and click tracking for your sending domains.\
> Each record includes the domain it applies to.\
> \
> Returns up to 1000 records per request. When the response includes a non-null \`last\_id\`, pass it as the \`last\_id\` query parameter to fetch the next page.\
> \
> Rate limit: 10 requests per minute per account.
```json
{"openapi":"3.1.0","info":{"title":"Email Sending","version":"2.0.0"},"tags":[{"name":"tracking-opt-outs","description":"Manage email addresses that have opted out of open and click tracking.\nTracking opt-outs are always scoped to a sending domain.\n"}],"servers":[{"description":"Mailtrap account API (`mailtrap.io`) for domains, suppressions, tracking opt-outs, stats, and email logs.\nError JSON matches other account endpoints (`error` or string `errors`), not the `send.api` / `bulk.api` sending shape (`success` + `errors` array).\n","url":"https://mailtrap.io"}],"security":[{"HeaderAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"HeaderAuth":{"type":"apiKey","description":"API token in Api-Token header","in":"header","name":"Api-Token"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication"}},"responses":{"GetTrackingOptOutsResponse":{"description":"List of tracking opt-outs","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TrackingOptOut"}},"last_id":{"type":["string","null"],"format":"uuid","description":"Cursor for the next page. Present when the response is a full page (1000 records);\npass this value as the `last_id` query parameter to continue. `null` when there are no more pages.\n"}}}}}},"BAD_REQUEST":{"description":"Bad request - invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"Unauthorized":{"description":"Returns unauthorized error message. Check your credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"Forbidden":{"description":"Returns forbidden error message. Check your permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionsDeniedResponse"}}}},"LIMIT_EXCEEDED":{"description":"Rate limit exceeded for the current account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededResponse"}}}}},"schemas":{"TrackingOptOut":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The tracking opt-out UUID"},"email":{"type":"string","format":"email"},"created_at":{"type":"string","format":"date-time"},"domain_name":{"type":"string","description":"Sending domain this tracking opt-out applies to"}}},"BadRequest":{"title":"BadRequestResponse","description":"Invalid parameters. Some endpoints return an empty body with HTTP 400; when present, a message may use an `error` field.\n","type":"object","properties":{"error":{"type":"string"}}},"UnauthenticatedResponse":{"title":"UnauthenticatedResponse","type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"PermissionsDeniedResponse":{"title":"PermissionsDeniedResponse","type":"object","properties":{"errors":{"type":"string","description":"Error message"}}},"RateLimitExceededResponse":{"title":"RateLimitExceededResponse","type":"object","properties":{"errors":{"type":"string","description":"Error message"}}}}},"paths":{"/api/tracking_opt_outs":{"get":{"summary":"List tracking opt-outs","description":"List email addresses that have opted out of open and click tracking for your sending domains.\nEach record includes the domain it applies to.\n\nReturns up to 1000 records per request. When the response includes a non-null `last_id`, pass it as the `last_id` query parameter to fetch the next page.\n\nRate limit: 10 requests per minute per account.\n","operationId":"getTrackingOptOuts","tags":["tracking-opt-outs"],"parameters":[{"name":"email","in":"query","description":"Filter tracking opt-outs by exact email address (case-insensitive).","schema":{"type":"string","format":"email"}},{"name":"start_time","in":"query","description":"Filter tracking opt-outs created at or after this timestamp (ISO 8601 format).","schema":{"type":"string","format":"date-time"}},{"name":"end_time","in":"query","description":"Filter tracking opt-outs created at or before this timestamp (ISO 8601 format).","schema":{"type":"string","format":"date-time"}},{"name":"last_id","in":"query","description":"The tracking opt-out UUID from the last record of the previous response. Returns records after this opt-out, enabling cursor-based pagination through large lists.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"$ref":"#/components/responses/GetTrackingOptOutsResponse"},"400":{"$ref":"#/components/responses/BAD_REQUEST"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/LIMIT_EXCEEDED"}}}}}}
```
## Create tracking opt-out
> Add an email address to the tracking opt-out list for a sending domain.\
> Opted-out addresses are excluded from open and click tracking on that domain.\
> \
> {% hint style="warning" %}\
> This endpoint requires admin-level access.\
> {% endhint %}\
> \
> Rate limit: 10 requests per minute per account.
```json
{"openapi":"3.1.0","info":{"title":"Email Sending","version":"2.0.0"},"tags":[{"name":"tracking-opt-outs","description":"Manage email addresses that have opted out of open and click tracking.\nTracking opt-outs are always scoped to a sending domain.\n"}],"servers":[{"description":"Mailtrap account API (`mailtrap.io`) for domains, suppressions, tracking opt-outs, stats, and email logs.\nError JSON matches other account endpoints (`error` or string `errors`), not the `send.api` / `bulk.api` sending shape (`success` + `errors` array).\n","url":"https://mailtrap.io"}],"security":[{"HeaderAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"HeaderAuth":{"type":"apiKey","description":"API token in Api-Token header","in":"header","name":"Api-Token"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication"}},"responses":{"CreateTrackingOptOutResponse":{"description":"Tracking opt-out created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrackingOptOut"}}}}}},"Unauthorized":{"description":"Returns unauthorized error message. Check your credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"Forbidden":{"description":"Returns forbidden error message. Check your permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionsDeniedResponse"}}}},"UnprocessableEntity":{"description":"Validation errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"}}}},"LIMIT_EXCEEDED":{"description":"Rate limit exceeded for the current account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededResponse"}}}}},"schemas":{"TrackingOptOut":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The tracking opt-out UUID"},"email":{"type":"string","format":"email"},"created_at":{"type":"string","format":"date-time"},"domain_name":{"type":"string","description":"Sending domain this tracking opt-out applies to"}}},"UnauthenticatedResponse":{"title":"UnauthenticatedResponse","type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"PermissionsDeniedResponse":{"title":"PermissionsDeniedResponse","type":"object","properties":{"errors":{"type":"string","description":"Error message"}}},"UnprocessableEntity":{"type":"object","description":"Validation errors per field. Keys are attribute names; values are arrays of human-readable messages.\nSome endpoints may also return a `base` key with general validation errors.","properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"RateLimitExceededResponse":{"title":"RateLimitExceededResponse","type":"object","properties":{"errors":{"type":"string","description":"Error message"}}}}},"paths":{"/api/tracking_opt_outs":{"post":{"summary":"Create tracking opt-out","description":"Add an email address to the tracking opt-out list for a sending domain.\nOpted-out addresses are excluded from open and click tracking on that domain.\n\n{% hint style=\"warning\" %}\nThis endpoint requires admin-level access.\n{% endhint %}\n\nRate limit: 10 requests per minute per account.\n","operationId":"createTrackingOptOut","tags":["tracking-opt-outs"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email","domain_id"],"properties":{"email":{"type":"string","format":"email","description":"Email address to opt out of tracking"},"domain_id":{"type":"integer","description":"ID of the sending domain this tracking opt-out applies to"}}}}}},"responses":{"201":{"$ref":"#/components/responses/CreateTrackingOptOutResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/LIMIT_EXCEEDED"}}}}}}
```
## Delete tracking opt-out
> Remove an email address from the tracking opt-out list so open and click tracking can apply again.\
> \
> {% hint style="warning" %}\
> This endpoint requires admin-level access.\
> {% endhint %}
```json
{"openapi":"3.1.0","info":{"title":"Email Sending","version":"2.0.0"},"tags":[{"name":"tracking-opt-outs","description":"Manage email addresses that have opted out of open and click tracking.\nTracking opt-outs are always scoped to a sending domain.\n"}],"servers":[{"description":"Mailtrap account API (`mailtrap.io`) for domains, suppressions, tracking opt-outs, stats, and email logs.\nError JSON matches other account endpoints (`error` or string `errors`), not the `send.api` / `bulk.api` sending shape (`success` + `errors` array).\n","url":"https://mailtrap.io"}],"security":[{"HeaderAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"HeaderAuth":{"type":"apiKey","description":"API token in Api-Token header","in":"header","name":"Api-Token"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication"}},"parameters":{"tracking_opt_out_id":{"name":"tracking_opt_out_id","in":"path","required":true,"description":"The tracking opt-out UUID","schema":{"type":"string","format":"uuid"}}},"responses":{"DeleteTrackingOptOutResponse":{"description":"Tracking opt-out deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingOptOut"}}}},"Unauthorized":{"description":"Returns unauthorized error message. Check your credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"Forbidden":{"description":"Returns forbidden error message. Check your permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionsDeniedResponse"}}}},"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"schemas":{"TrackingOptOut":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The tracking opt-out UUID"},"email":{"type":"string","format":"email"},"created_at":{"type":"string","format":"date-time"},"domain_name":{"type":"string","description":"Sending domain this tracking opt-out applies to"}}},"UnauthenticatedResponse":{"title":"UnauthenticatedResponse","type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"PermissionsDeniedResponse":{"title":"PermissionsDeniedResponse","type":"object","properties":{"errors":{"type":"string","description":"Error message"}}},"NotFoundResponse":{"title":"NotFoundResponse","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}},"paths":{"/api/tracking_opt_outs/{tracking_opt_out_id}":{"delete":{"summary":"Delete tracking opt-out","description":"Remove an email address from the tracking opt-out list so open and click tracking can apply again.\n\n{% hint style=\"warning\" %}\nThis endpoint requires admin-level access.\n{% endhint %}\n","operationId":"deleteTrackingOptOut","tags":["tracking-opt-outs"],"parameters":[{"$ref":"#/components/parameters/tracking_opt_out_id"}],"responses":{"200":{"$ref":"#/components/responses/DeleteTrackingOptOutResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.mailtrap.io/developers/email-sending/tracking-opt-outs.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.