agency-users

Invite a user to the agency

Invite a user as an agency staff member. Creates a pending invitation and sends an email.

Scope: agency-users:write

post/agencies/{agencyId}/invitations

Request

  • Base URL
    https://api.bokio.se/v1
  • URL
    https://api.bokio.se/v1/agencies/{agencyId}/invitations
  • Auth
    HTTP bearer

Request body

emailstring email required

Email address of the user to invite

Example request

{
  "email": "staff@agency.com"
}

Response

Invitation created

idstring uuid required

Unique identifier for the invitation

emailstring email required

Email address of the invited user

status'pendingInvitation' required

Status of the invitation

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.