---
title: "Create invite"
method: POST
path: "/v1/businesses/{client_id}/invites"
tags: ["Invites"]
---

# Create invite

`POST /v1/businesses/{client_id}/invites`

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

## Path parameters

- `client_id` integer, required

## Request body

- InviteCreateRequest
  - `email` string, email, required — The email address to send the invite to.
  - `role_id` string, uuid, required — The ID of the role to assign to the invitee. Must belong to the business.
  - `payment_types` PaymentType[], required — The payment types the invitee will have access to. Must be a non-empty list.

## Response `201`

Created

- Invite
  - `id` integer — The ID of the invite.
  - `email` string, email — The email address the invite was sent to.
  - `role_id` string, uuid — The ID of the role assigned to the invitee.
  - `role` string — The name of the role assigned to the invitee.
  - `payment_types` PaymentType[] — The payment types the invitee will have access to.
  - `used` boolean — Whether the invite has been accepted.
  - `created` string, date-time — The date and time the invite was created in UTC.
  - `updated` string, date-time — The date and time the invite was last updated in UTC.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/letsweel/apis/weel-openapi.md) · [All operations](https://skmtc.net/letsweel/apis/weel-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/letsweel/weel-openapi/versions/55da5fa350fb/schema)
