Update an already existing Segment

put

https://api.pushologies.com/v1/segment

Updates an already existing segment associated with tenant or parent tenant, given that the user has the necessary permissions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

uuid

required

ID of the segment to be updated.

name

string

required

Replace the segment's name.

description

string

Replace the segment's description.

dynamism

string

enum

If set to "one-time", the subscriber bucket for the segment will be created immediately. Subsequent notifications which use this segment will use the same subscriber list, meaning this won't include any new subscribers that appear after this segment has been created. If "always" is set, it means for each notification, at the time of each push a new subscriber list will be created using the segment rules, ensuring an always up to date subscriber pool captured by the segment.

Allowed:

rules

array

Rules which will be used to filter subscribers to add to your segment. Full reference can be found on the Segment rules page

rules

isHidden

boolean

Hide this segment from being viewed in the portalUI and from being returned in standard API requests that are not using the "showHidden" toggle

Responses

401

Id Token or X-API-Key/X-API-Secret is missing or invalid.

403

The server understood the request but refuses to authorize it. In most cases due to insufficient user permissions.

200Updated Segment

400Bad Request