BRbrandtrack
Users

Invites a user to the platform

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

post/v2/users

Request

Headers

x-customer-api-keystring

Request body

account_idinteger nullable required

The account where this user will be created.

emailstring required

The email to be registered.

firstnamestring required

User's firstname.

lastnamestring required

User's lastname.

role_idinteger required

The role to assign to the new user.

Example request

{
  "account_id": 19120,
  "email": "testexample@example.com",
  "firstname": "John",
  "lastname": "Doe",
  "role_id": 74
}

Response

Success

Example response

{
  "data": {
    "id": 18782,
    "uuid": "e66f37fd-ac0a-4cb6-adba-33196a5c6f3e",
    "email": "john.doe@brandtrack.fm",
    "firstname": "John",
    "lastname": "Doe",
    "phone_number": "+9332312323",
    "country": "BE",
    "role": "owner",
    "business_category_id": 62,
    "flags": [],
    "created_at": "2024-07-09T13:34:16+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.