Theme

Invitation ​

API endpoints for Invitation management in CSP.

Invite a user ​

http
POST /v1/csp/invitation/:as

Headers ​

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

Request Body ​

json
{
    "phone": "{{PhoneNumber}}",
    "name": "{{$randomFullName}}",
    "operator": {
        "role": "COORDINATOR", // `ADMIN`, `MANAGER`, `SUPERVISOR`, `COORDINATOR`, `DEVELOPER`
        "status": "ACTIVE",
        "bio": "Delivery transit coordination",
        "contacts": {
            "emails": [ "[email protected]" ],
            "phones": [ "+233 204 55323" ]
        }
    }
}

Cancel invitation ​

http
DELETE /v1/csp/invitation

Headers ​

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

Accept invitation ​

http
POST /v1/csp/invitation/accept

Headers ​

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