Samples

Number of APIs: 7

The Samples endpoint allows you to programmatically manage your Samples. Samples are ways of getting contacts from a list, using sample definitions to limit which contacts end up in the sample. With this endpoint, you can list the samples you have, as well as perform CRUD operations on them. When you create a sample, you can check on that samples progress, and once it is complete, you can retrieve the list of contacts that fit the sample definition.

Contact Support: Name: Support

1. directories-{directoryId}-samples-{sampleId} - Get Sample GET {{baseUrl}}/directories/:directoryId/samples/:sampleId

2. directories-{directoryId}-samples-{sampleId} - Update Sample PUT {{baseUrl}}/directories/:directoryId/samples/:sampleId

3. directories-{directoryId}-samples-progress-{progressId} - Get Create Sample Progress GET {{baseUrl}}/directories/:directoryId/samples/progress/:progressId

4. directories-{directoryId}-samples - Create Sample POST {{baseUrl}}/directories/:directoryId/samples

5. directories-{directoryId}-samples-{sampleId} - Delete Sample DELETE {{baseUrl}}/directories/:directoryId/samples/:sampleId

6. directories-{directoryId}-samples - List Samples GET {{baseUrl}}/directories/:directoryId/samples?pageSize=100&skipToken=<string>

7. directories-{directoryId}-samples-{sampleId}-contacts - Get Sample Contacts GET {{baseUrl}}/directories/:directoryId/samples/:sampleId/contacts?pageSize=50&skipToken=<string>&includeEmbedded=<boolean>