---
title: "Invite a user"
method: POST
path: "/users"
tags: ["Users"]
---

# Invite a user

`POST /users`

## Request

- Base URL: `https://sg.deployhq.com`
- URL: `https://sg.deployhq.com/users`
- Auth: HTTP basic

Invites a new user to the account. Sends an invitation email.

## Request body

- UserObject2
  - `user` object, required
    - `first_name` string, required
    - `last_name` string
    - `email_address` string, required
    - `time_zone` string
    - `account_administrator` boolean
    - `can_manage_users` boolean
    - `can_manage_billing` boolean
    - `can_manage_agents` boolean
    - `can_create_projects` boolean
    - `all_projects_allowed` boolean

## Response `201`

Created

- IdIdentifierFirstNameObject
  - `id` integer
  - `identifier` string
  - `first_name` string
  - `last_name` string
  - `email_address` string
  - `time_zone` string
  - `account_administrator` boolean
  - `activated` boolean
  - `can_manage_users` boolean
  - `can_manage_billing` boolean
  - `can_create_projects` boolean
  - `can_manage_agents` boolean
  - `all_projects_allowed` boolean

## Other responses

- `401`: You are not authorized to access this resource. You need to authenticate yourself first.
- `403`: You are not allowed to access this resource. You do not have the necessary permissions.
- `422`: Unprocessable Entity
- `500`: An unexpected error occurred on the server. The server was unable to process the request.

---

[API](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation.md) · [All operations](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation/revisions/830264ae58be?raw)