Skip to navigation

Remove Contacts from Static List

Removes contacts from a List. The contacts are not deleted. Maximum 500 contacts in each request. This operation uses POST because it has a request body. It is idempotent: a contact that is not on the List does not change, and you can safely retry failed contacts.

Contacts that do not exist or that the user cannot access are counted in invalid. The other contacts are still processed. URIs are listed only for contacts that were not removed.

A View returns 409, because the saved filters of a View decide its contacts.

Required scopes

contacts:write

Authentication

AuthorizationBearer
OAuth 2.0
OR
AuthorizationBearer
Personal Access Token

Path parameters

uuidstringRequired

The UUID of the contact list, from the end of its uri.

Request

This endpoint expects an object.
contactslist of stringsRequired
Contact URIs. Minimum 1, maximum 500. A contact that appears more than once is processed once.

Response

OK
resourceobject
The result of removing contacts from a List. This is a result payload, not an addressable resource. URIs are listed only for contacts that were not removed.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error