Sign in

v1

latestSwagger 2.02026-08-04244186228.2 KB
authentication

Invite a collaborator

post/v1/backoffice/customers

Query parameters

createWorkerstring

Headers

X-Fieldsstring mask

An optional fields mask

Request body

appUuidstring

App uuid

collaboratorRole'ADMIN' | 'INSTRUCTOR' | 'MEMBER'

Collaborator Role

emailstring

Email to invite collaborator

invitedAsFullUserboolean

Example request

{
  "collaboratorRole": "ADMIN"
}

Response

Success

acceptedstring date-time

Accepted date

appIdstring

App uuid

collaboratorEmailstring

Email of collaborator

collaboratorIdinteger

Id of collaborator

collaboratorRole'ADMIN' | 'INSTRUCTOR' | 'MEMBER'

Collaborator Role

collaboratorStatus'ACTIVE' | 'INACTIVE' | 'INVITED'

Collaborator status

createdstring date-time

Created date

idinteger

Id of collaboration/invitation

invitedstring date-time

Invitation date

invitedEmailstring

Email where invitation was send

ownerEmailstring

Email of owner

ownerIdinteger

Id of owner

orgRole'MEMBER' | 'OWNER'
invitedAsFullUserboolean
role'ADMIN' | 'INSTRUCTOR' | 'MEMBER' | 'OWNER'

Access Role

Example response

{
  "collaboratorRole": "ADMIN",
  "collaboratorStatus": "ACTIVE",
  "orgRole": "MEMBER",
  "role": "ADMIN"
}