segment_update

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

In the user_data field, the segments can be identified in multiple ways:

  • If the segment_key_type is ALTERNATIVE then the segments should use the alternative_id associated with the Segments object being used.
  • If the segment_key_type is DEFAULT or not set, the segments should either use an integer corresponding to the segment_id of the Segment object, OR the segment_key of the segment, which is in the format <KEY>-<ID> such as stinger-123.
Body Params
user_data
array of objects
required

JSON of the user-segment information to be added. See below for more details.

user_data*
string
Defaults to NAM

The destination continent data centers to upload the data. Only one continent may be specified per upload. If a segment is required across continents it must be uploaded twice. Options are NAM, EMEA, or APAC.

string
Defaults to DEFAULT

Indicates whether the user IDs in the uploaded file should be put into a segment defined by the segment_key or the alternative_id from the segment. Must be set to either DEFAULT or ALTERNATIVE.

string

Indicates the type of IDs being imported, as defined in the "segment_user_type" view. Valid types include BEESWAX, CUSTOMER, IDFA, IDFA_MD5, IDFA_SHA1 , AD_ID, AD_ID_MD5, AD_ID_SHA1 , IP_ADDRESS

string
Defaults to ADD_SEGMENTS

What action should be taken on these users. Commonly set to ADD_SEGMENTS or REPLACE_ALL_SEGMENTS

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json