PATCH
/
api
/
segments
/
{id}
Update Tenant Segment
curl --request PATCH \
  --url https://api.embedreach.com/api/segments/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "conditions": [
    {
      "field": "userId",
      "value": [
        "<string>"
      ],
      "operator": "equals"
    }
  ]
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "createdAt": "<string>",
    "type": "all_users"
  }
}

Headers

​
reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Path Parameters

​
id
string
required

The ID of the tenant segment to update

Body

application/json

Response

200
application/json

Status 200 response

The response is of type object.