Skip to main content
POST
Invite a team member
Use a user API key with users:write to invite a colleague to your entity. Include x-entity-id with the entity’s public ID. Your key needs write access to that entity, and you must currently have the Admin role. Entity service keys, partner keys, and MCP credentials cannot create invitations. Your entity’s approval policy applies to the invitation request. The response contains the request ID and its status. If the status is pending_approval, an administrator must approve the request in your dashboard. The invitation gives no access until your colleague accepts it. Choose an existing team role other than None. The same role restrictions apply as in your dashboard. The API rejects existing members, active invitations, and active invitation requests with HTTP 400. Repeating the request while an invitation or request is active does not send another invitation. Use your dashboard to resend an invitation.

Authorizations

x-api-key
string
header
required

Your Meow API key, sent in the x-api-key header for authentication.

Headers

x-entity-id
string<uuid>

Optional entity_id to scope requests to a specific entity.

Body

application/json
email
string<email>
required

Email address of the colleague you want to invite.

Maximum string length: 100
role
enum<string>
required

Role your colleague receives after accepting the invitation.

Available options:
Admin,
Viewer,
Bookkeeper,
Controller,
Card user,
Card manager,
Invoice user,
AP Clerk,
AP/AR Bookkeeper,
Bill Approver,
None

Response

Successful Response

id
string<uuid>
required

Invitation request ID. Use this to find the request in your dashboard's Approvals page.

status
enum<string>
required

Request status. A pending_approval request needs approval in your dashboard before your colleague receives an invitation.

Available options:
new,
pending_approval,
approved,
queued,
in_progress,
completed,
failed,
rejected,
expired