Segments

Update a segment

Partial update: an omitted field is left untouched. Changing a DYNAMIC segment's condition recomputes member_count in the same call, so the returned object never states a size that belongs to the previous filter. condition is ignored on a STATIC segment, whose membership is the explicit list.

type is not accepted here — see the create operation.

Requires the segments:write scope — Create, edit, and delete your segments.

patch/api/v1/segments/{id}

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/segments/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: segments:write)

Path parameters

idstring uuid required

Resource id.

Request body

descriptionstring
namestring
track_membershipboolean

Response

The updated segment

created_atstring date-time required
descriptionstring nullable required
idstring uuid required
member_countinteger required
namestring required
track_membershipboolean required
type'DYNAMIC' | 'STATIC' required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.