Create User

Required permissions: users.create.*

POST /users

Create User

cURL

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 '
{
  "department_id": 123,
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "[e-mail]",
  "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>",
  "activate": false,
  "is_silent": false
}
'

import requests

url = "https://{primary_domain}/api/public/v2.0/users"

payload = {
    "department_id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "[e-mail]",
    "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>",
    "activate": False,
    "is_silent": False
}
headers = {
    "X-Access-Key-Id": "<api-key>",
    "X-Access-Key-Secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Access-Key-Id': '<api-key>',
    'X-Access-Key-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    department_id: 123,
    first_name: '<string>',
    last_name: '<string>',
    email: '[e-mail]',
    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>',
    activate: false,
    is_silent: false
  })
};

fetch('https://{primary_domain}/api/public/v2.0/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{primary_domain}/api/public/v2.0/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'department_id' => 123,
    'first_name' => '<string>',
    'last_name' => '<string>',
    'email' => '[e-mail]',
    '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>',
    'activate' => false,
    'is_silent' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Access-Key-Id: <api-key>",
    "X-Access-Key-Secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{primary_domain}/api/public/v2.0/users"

	payload := strings.NewReader("{\n  \"department_id\": 123,\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"timezone\": \"<string>\",\n  \"work_hours\": {\n    \"sunday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"monday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"tuesday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"wednesday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"thursday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"friday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"saturday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ]\n  },\n  \"role\": \"<string>\",\n  \"activate\": false,\n  \"is_silent\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Access-Key-Id", "<api-key>")
	req.Header.Add("X-Access-Key-Secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{primary_domain}/api/public/v2.0/users")
  .header("X-Access-Key-Id", "<api-key>")
  .header("X-Access-Key-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"department_id\": 123,\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"timezone\": \"<string>\",\n  \"work_hours\": {\n    \"sunday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"monday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"tuesday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"wednesday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"thursday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"friday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"saturday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ]\n  },\n  \"role\": \"<string>\",\n  \"activate\": false,\n  \"is_silent\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{primary_domain}/api/public/v2.0/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Access-Key-Id"] = '<api-key>'
request["X-Access-Key-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"department_id\": 123,\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"timezone\": \"<string>\",\n  \"work_hours\": {\n    \"sunday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"monday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"tuesday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"wednesday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"thursday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"friday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ],\n    \"saturday\": [\n      {\n        \"start\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        },\n        \"end\": {\n          \"hour\": 12,\n          \"minute\": 30,\n          \"second\": 30\n        }\n      }\n    ]\n  },\n  \"role\": \"<string>\",\n  \"activate\": false,\n  \"is_silent\": false\n}"

response = http.request(request)
puts response.read_body

200

{
  "message": "<string>",
  "data": {
    "id": 123,
    "department_id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "[e-mail]",
    "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>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "avatar_url": "<string>",
    "name": "<string>",
    "department_name": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "errors": {
    "attribute": [
      "The {attribute} field is required."
    ]
  }
}

"Invalid or missing access key."

"Too many requests."

"An unexpected error occurred."

Authorizations

X-Access-Key-Id · string · header · required

X-Access-Key-Secret · string · header · required

Body

application/json

department_id · integer<int64> · required

first_name · string · required

Maximum string length: 255

last_name · string · required

Maximum string length: 255

email · string<email> · required

Maximum string length: 255

timezone · string · required

In IANA timezone format.

work_hours · object · required

Show child attributes

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

200

application/json

message · string · required

data · object · required

A User resource object.

Show child attributes