Skip to main content
PATCH
/
organizations
/
{organizationId}
/
onboard
/
bo
Onboard an organization
curl --request PATCH \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/organizations/{organizationId}/onboard/bo \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
{
  "billedEstablishmentCount": 5,
  "engagementDuration": 12
}
'
{
  "data": {
    "billedEstablishmentCount": 5,
    "engagementDuration": 12,
    "status": 4,
    "activatedAt": "2024-12-01T12:34:56.000Z",
    "engagementEndAt": "2024-12-01T12:34:56.000Z",
    "onboardedAt": "2024-12-01T12:34:56.000Z",
    "onboardedById": 1
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"
​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Path Parameters

​
organizationId
integer
required

Unique identifier of the organization.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Body

application/json

Details required to set an organization access

​
billedEstablishmentCount
integer
required

Number of paid establishments.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

5

​
engagementDuration
integer
required

Duration of the commitment in months.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

12

Response

204 - application/json

The organization have been onboarded

​
data
object
required