v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB

Users

Create user

This endpoint lets you create a user. If no password given, a password will automatically be generated.

The password will be ignored if send_invitation is set to True.

You need to have WRITE access on the organization of the user you want to create.

If you want to have an invited user but send the invitation email later, you have to send the send_invitation parameter as False and a status parameter to invited.
You will then have to call the invitation endpoint to send the invitation email to the user.

post/user

Request body

emailstring email required

User email (must be unique will return otherwise)

first_namestring required

User first name

last_namestring required

User last name

org_idinteger

Unique identifier of the organization to which the user should belong. Only PROVIDER users can set this field. If no org_id is given, or if you are not a PROVIDER, the user will have the same organization as you.

business_idsstring[]

The list of business to which the user has access to. Will be taken into account only if user has BUSINESS_MANAGER role.

role'ORG_ADMIN' | 'ORG_MANAGER' | 'GROUP_MANAGER' | 'BUSINESS_MANAGER' | 'PUBLISHER'

User role in the application

custom_rolestring

Optional API identifier of a custom role to assign to the user. The value must match the api_id of one of the custom roles available to your organization.

If no custom role is given, users with the role GROUP_MANAGER or BUSINESS_MANAGER will automatically be assigned to the default built-in custom role associated with their role.

For more information about custom roles, see Managing User Permissions with Custom Roles

sidebar_pagesSidebarPagesFeatureEnum[]

List of features the user can access from the sidebar.

send_invitationboolean

Send an invitation email to the User. If you want to have an invited user but send the invitation email later, you have to send the send_invitation parameter as False and a status parameter to invited.
You will then have to call the invitation endpoint to send the invitation email to the user.

status'active' | 'invited'

User status in the application

passwordstring password

The User password. It should comply with the following rules:

should be at least 8 characters long
should have one upper case letter and one lower case letter
should have one special character

lang'fr' | 'en' | 'es' | 'it' | 'pt-br' | 'de' | 'ar' | 'nl' | 'pl' | 'cs' | 'ca' | 'sk' | 'pt' | 'lv' | 'ro' | 'bg' | 'hu'

Available language in the application

sso_onlyboolean

Prevent the user from connecting directly from the Partoo connection page.

This field is available for users whose organization has defined an SSO configuration.

This field can be edited by a user with the role ORG_ADMIN or PROVIDER.

Example request

{
  "first_name": "Perceval",
  "last_name": "de Galles",
  "org_id": 42,
  "accesses": [
    [
      1,
      2
    ],
    [
      1,
      3
    ]
  ],
  "role": "BUSINESS_MANAGER",
  "custom_role": "my_custom_role",
  "status": "active",
  "lang": "fr"
}

Response

idstring

User id

status'success'

Request status

Example response

{
  "id": "5309c3a237bbc544d8e26737"
}