Create Segment

post

https://api.lodgestory.com/api/wp-crm/segments/{organisationId}

Create an empty segment, then add people with POST …/{segmentId}/members (up to 1,000 per call) or a CSV import. Names are unique per organisation, ignoring case; a duplicate name or externalId returns 409 with the existing segmentId in the body, so a retry never creates a second list.

Security:

The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

400

Bad request — invalid name / description / externalId

401

Unauthorized — invalid/expired JWT or organisation ID does not match the token

403

Forbidden — role not permitted

409

A segment with this name or externalId exists — body carries its segmentId

429

Too many requests

503

Segments are not available yet on this server

201