Create a new user

post

http://sync-dev.bkbn.com/v1/users

Creates a new user in the system. The user will be associated with the authenticated client's workspace. The user will still have to create their profile in the Auth0 authentication system, but their data will be linked upon successful login. Email is a mandatory field. Returns the full user profile including the generated BKBN primary key.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Broker to create or update in your workspace. On POST, email and country are both required; omitting either is refused with a 422 naming the field. On PATCH, send only the fields you want to change — an omitted field is left unchanged.

string

Broker's email address. Required on create; lower-cased before storage, so it is never case-sensitive. It is the broker's identity on the platform and must be unique — re-using an address currently surfaces as a server error rather than a conflict, so treat it as non-retryable and check your own records first.

firstName

string

Given name. Stored as an empty string when omitted on create.

lastName

string

Family name. Stored as an empty string when omitted on create.

country

string

enum

Country the broker operates in, as an ISO 3166-1 alpha-2 code. Required on create — it selects the price book the broker's orders are quoted from, so it is not cosmetic.

timezone

string

IANA timezone used for the broker's appointments and notifications. Defaults to Europe/Berlin when omitted on create.

language

string

enum

Language the broker is addressed in. Defaults to EN when omitted on create.

Allowed:

phone

string

Contact phone number. Stored as an empty string when omitted on create.

personalBillingReference

string

Your own billing reference for this broker (cost centre, agency code). Carried on the broker record for invoicing; not used for order matching — see the order's reference.

userReferenceId

string

This broker's id in your own system. Set it on create and you can address the broker by it afterwards (/users/by-reference/USERREFERENCEID) instead of storing our internalId. It cannot be changed by an update. Keep it unique within your workspace: nothing rejects a duplicate at write time, but the by-reference lookups then fail for every broker sharing it.

Responses

201User successfully created

400Invalid request

401Authentication required

403Access denied

422Unprocessable entity