API Reference

Create Segment

Create a new segment based on static list of users.

POST

https://api.walkme.com/public/v1/user/system/:SYSTEM_GUID/segment

PATH PARAMS

SYSTEM_GUID String

System GUID in the format of (8,4,4,4,12): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

BODY PARAMS

id String

An external ID of your choosing.

name String

WalkMe Segment Name – will be visible in the Editor

userIds Array of Strings

A list of the unique user ids that should be added to the segment.

"userIds": ["[email protected]", "[email protected]"] }

cURL Example

curl --location --request POST 'https://api.walkme.com/public/v1/user/system/:SYSTEM_GUID/segment' \
--header 'Authorization: Bearer {{INSERT BEARER TOKEN}}'
--header 'Content-Type: application/json' \
--data-raw '{
  "id":"1000-abcd-9999",
  "name": "Sales Department",
  "userIds":["[email protected]", "[email protected]"]
}'

Limitations:

Up to 25k users per request
Up to 100 characters per ID value.