Theme

Invitation ​

API endpoints for Invitation management in DEV.

Invite user to Developer workspace ​

http
POST /v1/devs/:xcode/invitation/:as

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)

Request Body ​

typescript
interface Invite user to Developer workspaceRequest {
  phone: string;
  name: string;
  developer: {
    role: string;
    status: string;
    contacts: {
    emails: string[];
    phones: string[]
  }
  };
}

Example:

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

Cancel invitation ​

http
DELETE /v1/devs/:xcode/invitation

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)

Accept invitation ​

http
POST /v1/devs/:xcode/invitation/accept

Headers ​

  • X-User-Agent (required)
  • X-Auth-Token (required)
  • X-Auth-Device (required)