Add users

This method allows to add multiple users to the account

Limitations

  • Method is available for administrator users only.
  • Method allows adding up to 10 users with a single request.
  • Method becomes unavailable if the number of users exceed 100. The limitation does not apply to the Pro and Enterprise plans.

Data type header when the request is successful
Content-Type: application/hal+json

Data type header in case of an error
Content-Type: application/problem+json

Request parameters

For this method, the request parameters have the following dependencies:

  • Administrator and Free user are not considered roles, they are defined by special flags: rights[is_free]
    and rights[is_admin]
  • Fields rights[leads], rights[tasks], rights[contacts], rights[companies] should take the rights dependencies into account

Response parameters
Method returns a collection of created users. The parameters are similar to the user list request parameters.

Body Params
RAW_BODY
array of objects
RAW_BODY
Headers
string
enum
Defaults to application/hal+json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
application/problem+json