Segments

Create a segment

Create a new segment in the community.

post/segments

Request

Base URL
https://api.commonroom.io/api/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/commonroom/apis/common-room-api-v2/docs/segments/post.ts
A function with typed inputs. Its response is checked against the schema.

namestring required

The name for the new segment (max 500 characters)

descriptionstring

Optional description for the segment (markdown supported)

entityType'contact' | 'object' | 'organization'

The type of entity this segment will contain

objectTypeIdstring

Required when entityType is object. Prefixed object type ID (format cot_<number>)

Created

successtrue required

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