BObokio
agency-connections

Connect to an agency

Connects the integration to an existing agency. Requires the integration to be approved for machine to machine auth on the Agency API. Request on already connected agencies will refresh scope to match the requested scope in client credentials grant.

Scope: agency-connections:write

post/agency-connections

Request

  • Base URL
    https://api.bokio.se/v1
  • URL
    https://api.bokio.se/v1/agency-connections
  • Auth
    • OAuth 2
      Authorization code: /authorize
      Client credentials
      Token URL: /token scopes: agency-connections:write
    • or HTTP bearer

Request body

agencyIdstring uuid required

The Bokio identifier of an existing agency

Response

Existing connection updated

idstring uuid required

Informational connection identifier

agencyIdstring uuid required
agencyNamestring required
organizationNumberstring nullable
scopesstring[] required
status'active' | 'disconnected' required
connectedDatetimestring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.