Skip to main content
A user represents an individual who can access your organization’s Partoo account.
Each user is uniquely identified by email, user_id, and a role. Users authenticate with either a password or Single Sign-On (SSO).
If SSO is enabled for your organization, you can restrict specific users to SSO-only access (sso_only: true).
This section covers user creation and invitation. See the Edit User and Delete User endpoints for the rest of the lifecycle.

​
Roles

RoleDescription
ORG_ADMIN (default)Full control over the entire organization.
Group ManagerManages one or more groups (collections of locations).
Business ManagerManages one or more individual business locations.

​
Authentication & SSO

  • Password login: The user sets a password that meets security rules.
  • SSO-only login: Set sso_only: true and omit (or set null) the password field.

​
Create a User

​
Prerequisites

  • API key passed in the x-APIKey header.
  • Unique email, first_name, last_name.
  • Optional role (defaults to ORG_ADMIN).

​
Endpoint

POST https://api.partoo.co/v2/user
x-APIKey: YOUR_API_KEY
Content-Type: application/json

​
Request & Response

Send one of the JSON payloads below.
A successful call returns 200 OK with the created user object.
Invitation rules
• send_invitation: true — an email is sent immediately (unless sso_only is true).
• send_invitation: false — create the account silently; trigger Reinvite User later.

​
Payload examples

  • ORG_ADMIN
  • Group Manager
  • Business Manager
{
  "email": "[email protected]",
  "first_name": "Alice",
  "last_name": "Admin",
  "role": "ORG_ADMIN",
  "password": "Str0ng#Pass!",
  "lang": "en",
  "sidebar_pages": ["diffusion", "review_management"],
  "preferences": { "language": "en" },
  "sso_only": false,
  "send_invitation": true
}

​
End-to-end request in multiple languages

  • cURL
  • Python (requests)
  • Java (OkHttp)
  • PHP (cURL)
curl -X POST 'https://api.partoo.co/v2/user' \
  -H 'x-APIKey: ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
        "email": "[email protected]",
        "first_name": "Alice",
        "last_name": "Admin",
        "role": "ORG_ADMIN",
        "password": "Str0ng#Pass!",
        "lang": "en",
        "sidebar_pages": ["diffusion","review_management"],
        "sso_only": false,
        "send_invitation": true
      }'

​
Parameters

NameTypeDefaultNotes
emailstring <email>— (required)Must be unique.
first_namestring— (required)User’s first name.
last_namestring— (required)User’s last name.
rolestringORG_ADMINOptional. One of ORG_ADMIN, GROUP_MANAGER, BUSINESS_MANAGER.
passwordstring | null—≥ 8 chars, 1 upper, 1 lower, 1 special. Can be null if sso_only is true.
langstring—UI language (fr, en, es, it, pt-br, de, ar, nl, pl, cs, ca, sk, pt, lv, ro, bg, hu).
sidebar_pagesarray<string>all featuresLimit visible sidebar items (bulk_modification, diffusion, feedback_management, messages, posts, etc.).
sso_onlybooleanfalseWhen true, disables password login.
send_invitationbooleanfalseWhether to send the invitation email immediately.
accessesarray<integer>—Group Manager only – list of group IDs.
business_idsarray<string>—Business Manager only – list of business IDs.

​
To do

Edit User

Change roles, SSO settings, or resend invitations.

Delete User

Permanently remove a user from your organization.