API Reference

Create a Segment

post
https://crm-api.portals.care/segments

Creates a new patient segment based on a set of defined criteria.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Schema for creating a new patient segment.

string
required

A unique and descriptive name for the segment.

criteria
object
required

A set of rules and conditions that define which patients belong to this segment. The structure of this object will depend on the available filtering options.

Headers
string
required

Your unique Organization ID.

Response
201

The segment was created successfully.

Updated 9 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 9 months ago

Did this page help you?