BUbuttondown
Segments

Update Segment

Changed on

Update a segment's properties

patch/segments/{id}

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/segments/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

Request body

namestring nullable

A human-readable name for the segment.

descriptionstring nullable

An optional free-form description of the segment, shown alongside its name when picking an email's audience.

Example request

{
  "name": "Executives",
  "description": "Leadership at customer accounts"
}

Response

OK

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

The date and time at which the object was first created.

namestring required

A human-readable name for the segment.

descriptionstring required

An optional free-form description of the segment, shown alongside its name when picking an email's audience.

Changes