agency-users
Invite a user to a client company
Invite a user to one of the agency's client companies. Creates a pending invitation and sends an email.
The invitation is sent on behalf of a company user, who is named as the inviter in the email and on the page where the invitation is accepted. By default this is the company owner. Use inviterUserId to send it on behalf of another company user. That user must have permission to manage users in the company, otherwise a 400 validation error is returned. If the company has no owner, inviterUserId is required and a 400 validation error is returned when it is omitted.
Scope: agency-users:write
post/agencies/{agencyId}/companies/{companyId}/invitations
Request
- Base URLhttps://api.bokio.se/v1
- URLhttps://api.bokio.se/v1/agencies/{agencyId}/companies/{companyId}/invitations
- AuthHTTP bearer
Request body
Example request
{
"email": "user@example.com",
"inviterUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}Response
Invitation created
Example response
{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"email": "user@example.com",
"status": "pendingInvitation"
}Changes
No recorded changes to this operation across all 1 revision of this API.