Profiles

Create profile

Create a profile for one of your customers, idempotently if you pass a key.

POSThttps://app.tryadeli.com/api/v1/profiles
AuthorizationBearer <API key>How keys work

Creates a profile in your organization and returns it with 201. Create one per customer when they sign up in your app, and store its id.

Headers

Idempotency-Keystring
Optional. Any unique string, such as your own customer id. Repeating it with the same body returns the profile it created instead of a conflict; repeating it with a different body returns 409 idempotency_conflict.

Body

namestringRequired
1–200 characters after trimming. Must be unique across your organization's profiles.
externalIdstring | null
Your own id for this customer, up to 200 characters. Must be unique across your organization's profiles when not null.
metadataobject | null
Any JSON object, up to 16 KiB encoded as UTF-8. Arrays and scalars are rejected.

A name or externalId that is already taken returns 409 with the existing profile's id in details.existingProfileId, so you can use that profile instead.

Errors — 401 unauthorized, 400 invalid_request, 400 invalid_profile, 409 profile_name_conflict, 409 profile_external_id_conflict, 409 idempotency_conflict, 502 database_error.