Update Segment Keys in Environment via JSON

Bulk upload a list of identifiers via JSON to a segment. The segment must exist before calling this endpoint. Segments are limited to 100,000 members and each call can only include 10,000 new members at a time. This endpoint requires a JSON body with the keys array and optional comment field; path and query parameters define which segment and environment to update.

👍 Tip

On the Enterprise plan, you can create large segments (that can contain over 100,000 members).

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

Access requirements

The Authorization Bearer (Admin API Key authorizing the request) must have one of the following roles and scopes:

Admin API Key roles accepted

  • API_ALL_GRANTED
  • API_SEGMENT_EDITOR

Admin API Key scopes accepted

  • GLOBAL
  • WORKSPACE
  • ENVIRONMENT

To learn more about Admin API Key roles and scopes, see API keys overview.


Request format

{"keys":["id1", "id2", "id3"], "comment":"a comment"}
Path Params
string
required

The ID of the FME environment where you want to upload the segment keys

string
required

The name of the segment to upload the keys to

Query Params
boolean
Defaults to false

Replace the content of the segment (if it previously exists) with the new content.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json