# Unsubscribed Contacts

## List Unsubscribed Contacts

> Retrieves a paginated list of all contacts who have unsubscribed from a specific program's Outreach communications.

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Programs","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"paths":{"/Advertisers/{AccountSID}/Campaigns/{CampaignId}/UnsubscribedContacts":{"get":{"summary":"List Unsubscribed Contacts","description":"Retrieves a paginated list of all contacts who have unsubscribed from a specific program's Outreach communications.","operationId":"listUnsubscribedContacts","tags":["Unsubscribed Contacts"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"CampaignId","in":"path","required":true,"description":"The unique identifier for the program.","schema":{"type":"integer"}},{"name":"PartnerId","in":"query","description":"Filter by partner ID.","schema":{"type":"integer"}},{"name":"UserEmail","in":"query","description":"Filter by a specific user email.","schema":{"type":"string","format":"email"}},{"name":"Page","in":"query","description":"The page number to retrieve, starting at 0.","schema":{"type":"integer","default":0}},{"name":"PageSize","in":"query","description":"The number of items per page. Maximum is 1000.","schema":{"type":"integer","default":20,"maximum":1000}}],"responses":{"200":{"description":"A paginated list of unsubscribed contacts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsubscribedContactsResponse"}}}}}}}},"components":{"schemas":{"UnsubscribedContactsResponse":{"type":"object","properties":{"Page":{"type":"integer","description":"The current page number. Starts at 0."},"NumPages":{"type":"integer","description":"The total number of pages available."},"PageSize":{"type":"integer","description":"The number of items per page. The maximum is 1000."},"Total":{"type":"integer","description":"The total number of unsubscribed contact records."},"Start":{"type":"integer","description":"The index of the first item on the current page."},"End":{"type":"integer","description":"The index of the last item on the current page."},"Uri":{"type":"string","format":"uri-reference","description":"The URI for the current page of results."},"FirstPageUri":{"type":"string","format":"uri-reference","description":"The URI for the first page of results."},"PreviousPageUri":{"type":"string","format":"uri-reference","nullable":true,"description":"The URI for the previous page of results, if any."},"NextPageUri":{"type":"string","format":"uri-reference","nullable":true,"description":"The URI for the next page of results, if any."},"LastPageUri":{"type":"string","format":"uri-reference","description":"The URI for the last page of results."},"Results":{"type":"array","description":"The list of unsubscribed contact objects on this page.","items":{"$ref":"#/components/schemas/UnsubscribedContact"}}}},"UnsubscribedContact":{"type":"object","properties":{"UserEmail":{"type":"string","format":"email","description":"The email address of the unsubscribed contact."},"PartnerId":{"type":"integer","description":"The unique identifier of the partner associated with the contact."},"CreatedAt":{"type":"string","format":"date-time","description":"The date and time the unsubscribe was created."},"UpdatedAt":{"type":"string","format":"date-time","description":"The date and time the unsubscribe was last updated."}}}}}}
```

## Unsubscribe a Contact

> Unsubscribes a contact from a specific program's Outreach communications on behalf of a partner.

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Programs","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"paths":{"/Advertisers/{AccountSID}/Campaigns/{CampaignId}/UnsubscribedContacts":{"post":{"summary":"Unsubscribe a Contact","description":"Unsubscribes a contact from a specific program's Outreach communications on behalf of a partner.","operationId":"unsubscribeContact","tags":["Unsubscribed Contacts"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"CampaignId","in":"path","required":true,"description":"The unique identifier for the program.","schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["PartnerId","UserEmail"],"properties":{"PartnerId":{"type":"integer","description":"The unique identifier for the Partner associated with the contact."},"UserEmail":{"type":"string","format":"email","description":"The email address of the contact to unsubscribe."}}}}}},"responses":{"200":{"description":"A confirmation object indicating success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessUriResponse"}}}}}}}},"components":{"schemas":{"SuccessUriResponse":{"type":"object","properties":{"Status":{"type":"string","description":"Indicates whether the operation was successful."},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to the affected resource."}}}}}}
```


---

# Agent Instructions: 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:

```
GET https://integrations.impact.com/brand-api-reference/reference/programs/unsubscribed-contacts.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.