Create a Match ALL Request for a new Segment

post

https://{yourAccountName}.api-us1.com/api/3/segmentMatchAll

Find all Contact Id's that match the given Segment. The provided segment will be saved with a 24 hour TTL. A new match-all request will be initiated. If results are not ready within 4 seconds, a response that lacks a result-set will be returned. Use the returned segmentId and runId to poll and check back later to see if the result-set is ready.

Query Params

sort

string

enum

Defaults to id

Comma delimited list of fields for which to sort the results. Optionally prepended with a dash sign to indicate descending order. Allowed fields: id, email, phone, first_name, last_name, full_name, cdate, udate, account_name, score, score, field. The score option will sort off of the value of a particular score. The field option will sort off of the value of a particular custom field.

page

integer

Defaults to 1

Page Number

page_size

integer

≤ 10000

Defaults to 20

Page Size. Maximum: 10,000

instant

string

enum

If present, API will return instantly with a runId without waiting for up to 4 seconds for the results to be ready. Useful if you want to kick off a match-all request but don't need the results immediately

Allowed:

Body Params

data

array of objects

data

errors

array of objects

errors

Responses

401

Unauthorized

403

Forbidden

404

Endpoint not found

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Segment match all request started and/or completed

400Bad Request