Contacts
A group of methods for working with the address book and contacts.
| Method | Description |
|---|---|
| POST /contact_lists/listId/contacts Creates one or more contacts in the contact list. Requires authorization and access right contacts_manage. | |
| POST /contact_lists/listId/properties Creates an additional field for the contact list. Requires authorization and access right contacts_manage. | |
| POST /contact_lists/listId/segments Creates a new segment for the contact list. Requires authorization and access right contacts_manage. | |
| POST /contact_lists Creates a contact list. Requires authorization and access right contacts_manage. | |
| DELETE /contact_lists/listId Deletes a contact list by its ID. Requires authorization and access right contacts_manage. | |
| DELETE /contact_lists/listId/contacts/contactId Deletes a contact in the contact list by its ID. Requires authorization and access right contacts_manage. | |
| DELETE /contact_lists/listId/contacts Deletes contacts in the contact list. This method supports the semantics of search queries. Requires authorization and access right contacts_manage. | |
| DELETE /contact_lists/listId/properties/propertyId Deletes a field from the contact list by its ID. Requires authorization and access right contacts_manage. | |
| DELETE /contact_lists/listId/segments/segmentId Deletes a segment from the contact list by its ID. Requires authorization and access right contacts_manage. | |
| DELETE /contact_lists Deletes contact lists. This method supports the semantics of search queries. Requires authorization and access right contacts_manage. | |
| DELETE /contact_lists/v1 Deletes contact lists in legacy format. This method supports the semantics of search queries. Requires authorization and access right contacts_manage. | |
| DELETE /contact_lists/v1/listId Deletes a legacy contact list by ID. Requires authorization and access right contacts_manage. | |
| GET /contact_lists/listId Returns a contact list by its ID. Requires authorization and access right contacts_view. | |
| GET /contact_lists/listId/contacts/contactId Returns a contact in the contact list by its ID. Requires authorization and access right contacts_view. | |
| GET /contact_lists/listId/properties Returns the fields in the contact list. Requires authorization and access right contacts_view. | |
| GET /contact_lists/listId/properties/propertyId Returns a field in the contact list by its ID. Requires authorization and access right contacts_view. | |
| GET /contact_lists/listId/segments/segmentId Returns a segment in the contact list by its ID. Requires authorization and access right contacts_view. | |
| GET /contact_lists/listId/segments Returns the segments in the contact list. Requires authorization and access right contacts_view. | |
| GET /contact_lists/v1/listId Returns contact lists in legacy format. Requires authorization and access right contacts_view. | |
| HEAD /contact_lists/listId/contacts Returns the number of contacts from the contact list that match the query. This method supports the semantics of search queries. Requires authorization and access right contacts_view. | |
| GET /contact_lists/listId/contacts Returns the contacts and contact list that match the query. This method supports the semantics of search queries. Requires authorization and access right contacts_view. | |
| HEAD /contact_lists Returns the number of contact lists that match the query. This method supports the semantics of search queries. Requires authorization and access right contacts_view. | |
| HEAD /contact_lists/v1 Returns the number of legacy contact lists that match the query. This method supports the semantics of search queries. Requires authorization and access right contacts_view. | |
| GET /contact_lists Returns lists of contacts that match the query. This method supports the semantics of search queries. Requires authorization and access right contacts_view. | |
| GET /contact_lists/v1 Returns legacy contact lists that match the query. This method supports the semantics of search queries. Requires authorization and access right contacts_view. | |
| PATCH /contact_lists/listId/contacts/contactId Edits a contact in the contact list by its ID. Requires authorization and access right contacts_manage. | |
| PATCH /contact_lists/listId/contacts Edits contacts in the contact list. This method supports partial updating, only those fields of the object that you specify in the request body will be changed. This method supports the semantics of search queries. Requires authorization and access right contacts_manage. | |
| PATCH /contact_lists/listId/properties/propertyId Edits the contact list field by its ID. This method supports partial updating, only those fields of the object that you specify in the request body will be changed. Requires authorization and access right contacts_manage. | |
| PATCH /contact_lists/listId/segments/segmentId Edits a contact list segment by its ID. Requires authorization and access right contacts_manage. | |
| PATCH /contact_lists/listId Edits the contact list. This method supports partial updating, only those fields of the object that you specify in the request body will be changed. Requires authorization and access right contacts_manage. | |
| POST /contact_lists/v1/listId Upgrades a contact list from a legacy format by its ID to the current format. Requires authorization and access right contacts_manage. |