API Reference

Update Segment

Update an existing segment

Update an existing segment.

PUT

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

PATH PARAMS

SYSTEM_GUID String

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

SEGMENT_GUID String

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

BODY PARAMS

action String

Desired update mode, accept only "add","remove" or "override"

userIds Array of Strings

List of users ids - limit - 25k users

{
  "action":"add",
  "userIds":["[email protected]", "[email protected]"]
}

cURL Example

curl --location --request PUT 'https://api.walkme.com/public/v1/user/system/:SYSTEM_GUID/segment/:SEGMENT_GUID' \
--header 'Authorization: Bearer {{INSERT BEARER TOKEN}}'
--header 'Content-Type: application/json' \
--data-raw '{
  "action":"add",
  "userIds":["[email protected]", "[email protected]"]
}'