Skip to main content
POST
/
api
/
company
/
workers
/
invite
Invite workers
curl --request POST \
  --url https://api.sandbox.bitwage.com/api/company/workers/invite \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_id": "<string>",
  "to_invite": [
    {
      "email": "jsmith@example.com",
      "role": "contractor",
      "external_id": "<string>"
    }
  ]
}
'
{
  "status": "success"
}

Authorizations

Authorization
string
header
required

API key authentication. Include your access token as: Authorization: Basic <ACCESS_TOKEN>

Body

application/json
company_id
string
required
to_invite
object[]
required

Response

200 - application/json

Invitations sent.

status
string
Example:

"success"