auth

Invite a member to the organization

post/v1/auth/members/invite

Request

  • Base URL: https://api.dispatchtickets.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.dispatchtickets.com/v1/auth/members/invite
  • Auth: session-token (a scheme the document does not define)

Request body

emailstring required
rolestring required

Role for the invited member (e.g., admin, member)

allBrandsboolean

If true, member has access to all current and future brands

brandIdsstring[]

Specific brand IDs the member can access (only used when allBrands is false)

Example request

{
  "email": "newuser@example.com",
  "role": "member",
  "allBrands": true,
  "brandIds": [
    "ws_abc123",
    "ws_def456"
  ]
}

Response

Invitation sent

Changes

No recorded changes to this operation across all 1 revision of this API.