Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Invites

Create invite

Creates and sends an invite to the given email address. Returns the created invite, including its ID for use in the cancel endpoint.

post/v1/businesses/{client_id}/invites

Path parameters

client_idinteger required
Example:123

The ID of the business.

Request body

emailstring email required

The email address to send the invite to.

role_idstring uuid required

The ID of the role to assign to the invitee. Must belong to the business.

payment_typesPaymentType[] required

The payment types the invitee will have access to. Must be a non-empty list.

Example request

{
  "email": "jane.doe@example.com",
  "role_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "payment_types": [
    "cards",
    "reimbursements"
  ]
}

Response

Created

idinteger

The ID of the invite.

emailstring email

The email address the invite was sent to.

role_idstring uuid

The ID of the role assigned to the invitee.

rolestring

The name of the role assigned to the invitee.

payment_typesPaymentType[]

The payment types the invitee will have access to.

usedboolean

Whether the invite has been accepted.

createdstring date-time

The date and time the invite was created in UTC.

updatedstring date-time

The date and time the invite was last updated in UTC.

Example response

{
  "id": 99,
  "email": "jane.doe@example.com",
  "role_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "role": "Team Member",
  "payment_types": [
    "cards",
    "reimbursements"
  ],
  "created": "2026-05-01T00:00:00Z",
  "updated": "2026-05-01T00:00:00Z"
}