Skip to main content
POST
Invite an accountant user
This endpoint only works with the Accountant API key. More information here

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json

Invite accountant user

email
string<email>
required

Email address that should receive the invitation.

Example:

"frida@example.com"

role
required

Role to assign to the invited user. Can be 'admin', 'user', or a custom role ID.

Available options:
admin,
user
Example:

"admin"

Response

Accountant user invited

id
string<cuid>
required

Identifier of the accountant user.

Example:

"cmf41ajzv003706un4i99q1b1"

createdAt
string<date-time>
required

ISO 8601 timestamp when the accountant user record was created.

Example:

"2024-08-20T12:34:56Z"

email
string<email>
required

Email address of the accountant user.

Example:

"alex@example.com"

firstName
string | null
required

First name of the accountant user, if provided.

Example:

"Alex"

lastName
string | null
required

Last name of the accountant user, if provided.

Example:

"Müller"

roles
object[]
required

Roles assigned to the accountant user.