Create a person - ClearPolicy

curl --request POST \ --url https://api.clearpolicy.app/api/v1/people \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "<string>", "email": "jsmith@example.com", "phone": "<string>" } '

{ "id": "<string>", "organization_id": "<string>", "name": "<string>", "email": "jsmith@example.com", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "phone": "<string>", "source_id": "<string>", "archived_at": "2023-11-07T05:31:56Z" }

Authorizations

Authorization

string

header

required

OAuth 2.0 bearer token obtained via the client credentials flow with the api:use scope.

Body

application/json

name

string

required

The full name of the person.

Maximum string length: 255

string<email>

required

The email address. Must be unique within your organization.

Maximum string length: 255

phone

string

Phone number in international format (e.g. +12025550147).

Response

The created person.

string

required

The ULID of the person.

organization_id

string

required

The ULID of the organization.

name

string

required

The full name of the person.

string<email>

required

The email address of the person.

source

enum<string>

required

How the person was created.

Available options:

oauth,

web,

system,

planning_center

created_at

string<date-time>

required

When the person was created.

updated_at

string<date-time>

required

When the person was last updated.

phone

string | null

The phone number in international format, or null.

source_id

string | null

An external identifier from the originating system, or null.

archived_at

string<date-time> | null

When the person was archived, or null if active.

Documentation Index

Authorizations

Body

Response