Skip to main content
๐ŸŽ‰ API version '2024-10-01' just released with many new features. If you are still on an older version, check the migration guide.

Create a user

POST 

/users

Creates a Core API user.

Requestโ€‹

Body

required
    external_id stringnullable

    Possible values: <= 256 characters

    A unique identifier for the user from another system which is given to Nabla.

    metadata objectnullable

    You can use this parameter to attach key-value data to the object. You can specify up to 50 keys, with key names up to 40 characters long, all values must be of type string and up to 500 characters long.

    You should not use this to store Protected Health Information (PHI) or any patient-related data.

    property name* string

Responsesโ€‹

User.

Schema
    id uuidrequired

    A unique identifier.

    activated booleanrequired

    Always true unless you explicitly deactivate the user.

    external_id stringnullable

    Possible values: <= 256 characters

    A unique identifier for the user from another system which is given to Nabla.

    metadata objectnullable

    You can use this parameter to attach key-value data to the object. You can specify up to 50 keys, with key names up to 40 characters long, all values must be of type string and up to 500 characters long.

    You should not use this to store Protected Health Information (PHI) or any patient-related data.

    property name* string
    created_at date-timerequired

    The creation date of this object, in ISO 8601 format.

Loading...