POST
/api/public/v1/employee-invitations

Invite an employee

Invite a person to join your company via SMS to their phone number.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

employee:invitations:write

Request Body

PropertyTypeDescription
phoneNumberstringE.164 phone number.
notestringPersonal message to include.
POSTExample request
curl
curl -X POST "https://www.pxb.app/api/public/v1/employee-invitations" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumber": "+15551234567",
    "note": "Welcome aboard!"
  }'
200Example response
json
{
  "message": "Invitation created successfully!",
  "content": {
    "invitation": {
      "id": "inv_1",
      "status": "PENDING"
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Employees → Invitations
/employee/invitations
  1. Invite an employee by phone number.