Contacts

Create a segment

Create a manual segment for organizing contacts and targeting broadcasts.

post/v1/segments

Request

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

Request body

namestring required
descriptionstring nullable
colorstring nullable

Example request

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

Response

Segment created

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.