---
title: "Invites a user to the platform"
method: POST
path: "/v2/users"
tags: ["Users"]
---

# Invites a user to the platform

`POST /v2/users`

## Request

- Base URL: `https://developers.brandtrack.ai/api.brandtrack.fm`
- URL: `https://developers.brandtrack.ai/api.brandtrack.fm/v2/users`
- Auth: API key in header `x-customer-api-key`
- TypeScript: <https://skmtc.dev/brandtrack/apis/brandtrack-api-documentation/docs/v2/users/post.ts> (a function with typed inputs; its response is checked against the schema)

It will send automatically an email to the provided email address with a unique link to setup the user's account.

## Headers

- `x-customer-api-key` string

## Request body

- object
  - `account_id` integer, nullable, required: The account where this user will be created.
  - `email` string, required: The email to be registered.
  - `firstname` string, required: User's firstname.
  - `lastname` string, required: User's lastname.
  - `role_id` integer, required: The role to assign to the new user.

## Response `200`

Success

- object
  - `data` object
    - `id` integer
    - `uuid` string
    - `email` string
    - `firstname` string
    - `lastname` string
    - `phone_number` string
    - `country` string
    - `role` string
    - `business_category_id` integer
    - `flags` unknown[]
      - unknown
    - `created_at` string

---

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