Table of Contents:
Table of Contents minLevel 2
Note: Notice that in each API call you must provide the List ID that you are working on, otherwise the default List ID will be used.
Methods Summary
GET /api/contact_counts/<id>
Description
- This method provides a count for specific Count ID.
- In order to get Count Id, first use POST /api/contact_counts method as detailed in the next section.
...
Error Codes
- 404 - Not found
POST /api/contact_counts
Description
Count process: Counts number of contacts by a particular criteria or segment. Returns count of contacts.
...
Initiate a count process, typically used to get the latest count for a Segment but can also be done on a criteria.
- This method returns a Count ID in response.
Use the Count ID received from this POST request in the GET method above in order to get the number count of contacts for the criteria provided in this POST request.
...
- 404 - Not found
- 500 - Validation error
...
Segment Count Example
Segment Count Post Example
...