Theme

Invitation ​

API endpoints for Invitation management in WORKSPACE.

Invite an admin into the workspace ​

http
POST /v1/:wid/invitation/admin

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Request Body ​

typescript
interface Invite an admin into the workspaceRequest {
  phone: string;
  name: string;
  admin: {
    role: string;
    status: string;
    contacts: {
    emails: string[];
    phones: string[]
  }
  };
}

Example:

json
{
  "phone": "{{PhoneNumber}}",
  "name": "{{$randomFullName}}",
  "admin": {
    "role": "MAINTAINER",
    "status": "ACTIVE",
    "contacts": {
      "emails": [
        "[email protected]"
      ],
      "phones": [
        "+233205005999"
      ]
    }
  }
}

Cancel invitation ​

http
DELETE /v1/:wid/invitation

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Accept invitation ​

http
POST /v1/:wid/invitation/accept

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)