SupportWire API
API ReferenceUsers

Invite team member

Required scope: `users:write`, `actor=self` token held by an admin.

POST
/api/oauth/v1/users

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth access token, e.g. Authorization: Bearer swot_….

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/oauth/v1/users" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'
{
  "data": {
    "id": "string",
    "role": "admin",
    "archived": true,
    "user": {
      "id": "string",
      "name": "string",
      "email": "string",
      "instagram_handle": "string",
      "profile_picture_url": "string"
    }
  }
}
{
  "error": "insufficient_scope",
  "error_description": "The token is missing a required scope."
}