Create User

Creates a new user in this account.

Only Administrators and Account Owners can create users. The new user will receive a welcome/invite email unless sendInvite is set to false.

You may optionally pass mailboxes to grant the new user email access to one or more inboxes as part of the same request. Each entry is an object with an id (required) and an optional emailAccess boolean (defaults to true). The inboxes must belong to the caller/new user’s company, and the caller must have email access to each one.

Example

Request

POST /v2/users HTTP/1.1
Authorization: Bearer oauth_token
Content-Type: application/json

{
  "firstName" : "New",
  "lastName" : "Agent",
  "email" : "new-agent@example.com",
  "role" : "user",
  "timezone" : "America/New_York",
  "jobTitle" : "Support Agent",
  "phone" : "+1 555 0100",
  "sendInvite" : true,
  "mailboxes" : [ {
    "id" : 1,
    "emailAccess" : true
  }, {
    "id" : 2,
    "emailAccess" : true
  } ]
}

Response

HTTP/1.1 201 Created
Resource-ID: 7
Location: https://api.helpscout.net/v2/users/7

Request/response fields

Request fields

Path	Type	Required	Description
`firstName`	`String`	Y	First name of the new user (max 40 characters)
`lastName`	`String`	Y	Last name of the new user (max 40 characters)
`email`	`String`	Y	Email address of the new user.
`role`	`String`	Y	Role to assign. Accepted values: `admin` `user` `light user` The `owner` role cannot be assigned through this endpoint.
`timezone`	`String`	N	User’s timezone. Defaults to the company timezone.
`jobTitle`	`String`	N	User’s job title (max 50 characters).
`phone`	`String`	N	User’s phone number.
`sendInvite`	`Boolean`	N	Whether to send the new user a welcome/invite email. Defaults to `true`.
`mailboxes`	`Array`	N	Optional. Inbox access to grant the new user at creation.
`mailboxes[].id`	`Number`	Y	Inbox ID.
`mailboxes[].emailAccess`	`Boolean`	N	Whether to grant email access to this inbox. Defaults to `true`.

Response Headers