Contacts

Update a segment

Change the name, description or color of a segment. Only the fields sent change.

patch/v1/segments/{id}

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/segments/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The segment ID

Request body

namestring
descriptionstring nullable
colorstring nullable

Example request

{
  "name": "Customers",
  "description": "Paying customers",
  "color": "#10b981"
}

Response

Segment updated

idstring required
namestring required
descriptionstring nullable
colorstring nullable
contact_countinteger
created_atstring date-time
updated_atstring date-time
objectstring

Example response

{
  "id": "clx_segment123",
  "name": "Customers",
  "color": "#10b981",
  "contact_count": 42,
  "object": "segment"
}

Changes

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