Skip to main content
POST
/
users
Create User
curl --request POST \
  --url https://{primary_domain}/api/public/v2.0/users \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Key-Id: <api-key>' \
  --header 'X-Access-Key-Secret: <api-key>' \
  --data '{
  "activate": false,
  "is_silent": false,
  "department_id": 123,
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "timezone": "<string>",
  "work_hours": {
    "sunday": [
      {
        "start": {
          "hour": 12,
          "minute": 30,
          "second": 30
        },
        "end": {
          "hour": 12,
          "minute": 30,
          "second": 30
        }
      }
    ],
    "monday": [
      {
        "start": {
          "hour": 12,
          "minute": 30,
          "second": 30
        },
        "end": {
          "hour": 12,
          "minute": 30,
          "second": 30
        }
      }
    ],
    "tuesday": [
      {
        "start": {
          "hour": 12,
          "minute": 30,
          "second": 30
        },
        "end": {
          "hour": 12,
          "minute": 30,
          "second": 30
        }
      }
    ],
    "wednesday": [
      {
        "start": {
          "hour": 12,
          "minute": 30,
          "second": 30
        },
        "end": {
          "hour": 12,
          "minute": 30,
          "second": 30
        }
      }
    ],
    "thursday": [
      {
        "start": {
          "hour": 12,
          "minute": 30,
          "second": 30
        },
        "end": {
          "hour": 12,
          "minute": 30,
          "second": 30
        }
      }
    ],
    "friday": [
      {
        "start": {
          "hour": 12,
          "minute": 30,
          "second": 30
        },
        "end": {
          "hour": 12,
          "minute": 30,
          "second": 30
        }
      }
    ],
    "saturday": [
      {
        "start": {
          "hour": 12,
          "minute": 30,
          "second": 30
        },
        "end": {
          "hour": 12,
          "minute": 30,
          "second": 30
        }
      }
    ]
  },
  "role": "<string>"
}'
{
  "message": "<string>",
  "data": {
    "id": 123,
    "department_id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "status": 0,
    "timezone": "<string>",
    "work_hours": {
      "sunday": [
        {
          "start": {
            "hour": 12,
            "minute": 30,
            "second": 30
          },
          "end": {
            "hour": 12,
            "minute": 30,
            "second": 30
          }
        }
      ],
      "monday": [
        {
          "start": {
            "hour": 12,
            "minute": 30,
            "second": 30
          },
          "end": {
            "hour": 12,
            "minute": 30,
            "second": 30
          }
        }
      ],
      "tuesday": [
        {
          "start": {
            "hour": 12,
            "minute": 30,
            "second": 30
          },
          "end": {
            "hour": 12,
            "minute": 30,
            "second": 30
          }
        }
      ],
      "wednesday": [
        {
          "start": {
            "hour": 12,
            "minute": 30,
            "second": 30
          },
          "end": {
            "hour": 12,
            "minute": 30,
            "second": 30
          }
        }
      ],
      "thursday": [
        {
          "start": {
            "hour": 12,
            "minute": 30,
            "second": 30
          },
          "end": {
            "hour": 12,
            "minute": 30,
            "second": 30
          }
        }
      ],
      "friday": [
        {
          "start": {
            "hour": 12,
            "minute": 30,
            "second": 30
          },
          "end": {
            "hour": 12,
            "minute": 30,
            "second": 30
          }
        }
      ],
      "saturday": [
        {
          "start": {
            "hour": 12,
            "minute": 30,
            "second": 30
          },
          "end": {
            "hour": 12,
            "minute": 30,
            "second": 30
          }
        }
      ]
    },
    "avatar_url": "<string>",
    "role": "<string>",
    "name": "<string>",
    "department_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-Access-Key-Id
string
header
required
​
X-Access-Key-Secret
string
header
required

Body

application/json
​
department_id
integer
required
​
first_name
string
required
Maximum length: 255
​
last_name
string
required
Maximum length: 255
​
email
string<email>
required
Maximum length: 255
​
timezone
string
required

In IANA timezone format.

​
work_hours
object
required
​
role
string
required

Must be an existing Role name.

​
activate
boolean
default:false

Required permissions: users.lock.*. If true, User's status is automatically activated. Must be true is is_silent if true.

​
is_silent
boolean
default:false

If true, no invitation email is sent.

Response

​
message
string
required
​
data
object
required

A User resource object.