Skip to main content

CreateRequest

usernamestring

Possible values: <= 200 characters

sourceSource (string)

source social network of profile

Possible values: [ig, fb, tt, tw, li]

Default value: tw
namestring

Possible values: <= 100 characters

statestring

Possible values: <= 64 characters

phonestring

Possible values: Value must match regular expression ^\+1\d{10}$

phone_countrystring

Possible values: [US]

analytics_event_idstring

Optional UUID generated by the client to pair this request with the browser Meta-pixel Search eventID, so Meta can deduplicate the pixel event against the corresponding server-side event. If omitted, no matching server-side event is sent for this search.

originPeopleSearchOrigin (string)

How the report's search was started. chat = the People search flow.

Possible values: [chat]

fields object

People search: the search fields. When present the server derives name / username / phone / state from it, stamps the report with search_state and origin, and the report is refined through POST /people-search/run/{reportId}. One of fields.name / fields.username / fields.phone is required (400 otherwise).

namestring

Possible values: <= 100 characters

usernamestring

@handle, with or without the @; up to 3 handles or profile links, comma or space separated

Possible values: <= 200 characters

phonestring

A full number ALWAYS makes the report a phone lookup, wherever it arrives (at create or in a later round): the number ALONE is searched — a name and facts sent with it are kept on the report, not searched — and the results are masked from that round on. There is no combined "name + phone" search. The last two digits alone are not a phone number: such a value is dropped and never masks anything.

Possible values: <= 40 characters

locationstring

Possible values: <= 100 characters

statestring

Possible values: <= 64 characters

countrystring

Possible values: <= 64 characters

infostring

Anything else, free text — the pieces of several turns, ; -separated.

Possible values: <= 500 characters

genderstring

male or female (any case); anything else is dropped.

Possible values: <= 16 characters

languagestring

Possible values: <= 16 characters

workstring

Possible values: <= 200 characters

interestsstring

Possible values: <= 200 characters

lifestring

Possible values: <= 200 characters

brandstring

Possible values: <= 100 characters

CreateRequest
{
"username": "string",
"source": "tw",
"name": "string",
"state": "string",
"phone": "string",
"phone_country": "US",
"analytics_event_id": "string",
"origin": "chat",
"fields": {
"name": "string",
"username": "string",
"phone": "string",
"location": "string",
"state": "string",
"country": "string",
"info": "string",
"gender": "string",
"language": "string",
"work": "string",
"interests": "string",
"life": "string",
"brand": "string"
}
}