---
title: "Invite a team member"
method: POST
path: "/users/invitations"
tags: ["Users"]
---

# Invite a team member

`POST /users/invitations`

## Request

- Base URL: `https://api.meow.com/v1`
- URL: `https://api.meow.com/v1/users/invitations`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/meow/apis/meow-api/docs/users/invitations/post.ts> (a function with typed inputs; its response is checked against the schema)

Invite a colleague to your entity using a user API key with users:write and current admin access. Your key must have approved write access to the entity. Entity service keys cannot invite users. Your entity's approval policy applies before the invitation is sent. Your colleague must accept the invitation before gaining access. Existing members, pending invitations, and active invitation requests are rejected. Retrying while a request or invitation is active does not send another invitation.

## Headers

- `x-entity-id` string, uuid

## Request body

- CreateUserInvitationRequest
  - `email` string, email, required: Email address of the colleague you want to invite.
  - `role` 'Admin' | 'Viewer' | 'Bookkeeper' | 'Controller' | 'Card user' | 'Card manager' | 'Invoice user' | 'AP Clerk' | 'AP/AR Bookkeeper' | 'Bill Approver', required: Role your colleague receives after accepting the invitation.

## Response `201`

Successful Response

- CreateUserInvitationResponse
  - `approval_id` string, uuid, required: Approval ID. Use it with GET /approvals/{approval_id} to check the request status.
  - `status` 'pending_approval' | 'approved' | 'executing' | 'under_review' | 'completed' | 'rejected' | 'expired' | 'failed', required

## Other responses

- `400`: The request could not be processed.
- `401`: Authentication failed.
- `403`: The API key is not authorized for this operation, or the user of a global API key is an admin or controller without approved KYC. The KYC case returns the message `KYC is required for controllers and admins.` until that user completes KYC in the Meow dashboard.
- `429`: Too many requests.

---

[API](https://skmtc.dev/meow/apis/meow-api.md) - [All operations](https://skmtc.dev/meow/apis/meow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/meow/apis/meow-api/revisions/ea2d7e25b63b?raw)
