Skip to main content
Clear Contact List
curl --request POST \
  --url https://integration.getmateo.com/api/v1/contact_list/clear \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_list_external_id": "<string>"
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
contact_list_id
string<uuid>

ID of the contact list to clear

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
contact_list_external_id
string

External ID of the contact list to clear

Response

Contact list cleared successfully

​
success
boolean
required