---
title: "Invite user"
method: POST
path: "/v2/invites"
tags: ["Accounts and users"]
---

# Invite user

`POST /v2/invites`

## Request

- Base URL: `https://yourbaseurl.talon.one`
- URL: `https://yourbaseurl.talon.one/v2/invites`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/talon/apis/management-api/docs/v2/invites/post.ts> (a function with typed inputs; its response is checked against the schema)

> [!note] Management API endpoints are **not** meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Create a new user in the account and send an invitation to their email
address.

> [!note] The invitation token is valid for 24 hours after the email has
> been sent. You can resend an invitation to a user with the [Resend
> invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail)
> endpoint.

## Request body

- NewInvitation: Parameters for inviting a new user.
  - `name` string: Name of the user.
  - `email` string, email, required: Email address of the user.
  - `isAdmin` boolean: Indicates whether the user is an `admin`.
  - `roles` integer[]: A list of the IDs of the roles assigned to the user.
  - `acl` string: Indicates the access level of the user.

## Response `201`

Created

- User
  - `id` integer, required: The internal ID of this entity.
  - `created` string, date-time, required: The time this entity was created.
  - `modified` string, date-time, required: The time this entity was last modified.
  - `email` string, email, required: The email address associated with the user profile.
  - `accountId` integer, required: The ID of the account that owns this entity.
  - `name` string, required: Name of the user.
  - `state` 'invited' | 'active' | 'deactivated', required: State of the user.
  - `inviteToken` string, required: Invitation token of the user. **Note**: If the user has already accepted their invitation, this is `null`.
  - `isAdmin` boolean: Indicates whether the user is an `admin`.
  - `policy` object, required: Access level of the user.
  - `roles` integer[]: A list of the IDs of the roles assigned to the user.
  - `authMethod` string: Authentication method for this user.
  - `applicationNotificationSubscriptions` object: Application notifications that the user is subscribed to.
  - `lastSignedIn` string, date-time: Timestamp when the user last signed in to Talon.One.
  - `lastAccessed` string, date-time: Timestamp of the user's last activity after signing in to Talon.One.
  - `latestFeedTimestamp` string, date-time: Timestamp when the user was notified for feed.
  - `additionalAttributes` object: Additional user attributes, created and used by external identity providers.

---

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