Create a user

Mints an API client. clientId and secret are the Basic credential, chosen by the caller and never returned. role may be v1's lowercase. A SUBSCRIBER needs webhookUrl and at least one event. It is on eventSchema 2 unless the body says 1: on 2 its first Standard Webhooks signing secret is returned this once as signingSecret; on 1 it needs webhookSecret (v1 called it secret). reach is attached (default: the patients attached to it, as v1's) or all (every patient of the tenant, those enrolled later included).

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

Validated against the assignable roles rather than the full enum, so this
MANAGER-gated route cannot mint a cross-tenant SUPER_ADMIN credential.

Allowed:
string
required
length between 1 and 128
string
required
length between 8 and 256
string
length ≤ 200
uri
string
length between 16 and 256
events
array of strings
length ≥ 1
events
string
length ≤ 1024

v1's custom: an opaque string every webhook carries back as x-actimi-custom.

number
enum

1 keeps v1's event names and bodies; 2, the default, sends one name per state change.

Allowed:
string
enum

attached: the patients attached to it, as v1's; all: every patient of the tenant, later ones included.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json