By area
Contacts
Written beside the API’s code, and read from it every hour.
| Method | Path | What it does |
|---|---|---|
| GET | /v1/contacts/fields | Your contact fields, with is_match, is_phone and their order |
| GET | /v1/contacts | The contacts, 100 a page by default and up to 500, with search across every value |
| POST | /v1/contacts | Create or update one ({"fields": {...}}) or up to 500 ({"contacts": [...]}) |
| DELETE | /v1/contacts | Delete one ({"id": 5031}) or up to 500 ({"ids": [...]}) |
| GET | /v1/contacts/lookup?phone= | The contacts a number belongs to, up to 10 |
Deleting one contact answers {"deleted": 5031}, or 404 when it does not exist. A batch delete answers a summary with the ids it deleted and one error for each id it could not. The lookup needs at least 7 digits (400 otherwise). Matching and phone rules are in Sync contacts.