Skip to main content

How to create a new user?

  • Updated

Index

Overview

Use this endpoint to create a new user in your Pandapé account. By default, certain permissions may be enabled, but you can adjust them to match your organization’s needs.

POST /v2/company/users
  • Method: POST
  • URL: /v2/company/users
  • Content-type: application/json

 

Request body

Provide a JSON object containing the user’s details. Below is a sample structure:

{
  "Name": "string",
  "Surname": "string",
  "Email": "string",
  "Phone": "string",
  "IsAllowedToPublish": true,
  "IsRequestManager": true,
  "IsOnboardingManager": true,
  "IsAllowedToRequest": true,
  "IsAllowedToChangeRequestFlow": true,
  "IsAllowedToOverrideRequest": true,
  "IsAllowedToPrime": true
}

 

Field descriptions

Below is a list of all user fields, including their data types, whether they are required, and a brief description of each.

Field Type Required Description
Name string Yes The user’s given name (e.g., “John”).
Surname string Yes The user’s family name (e.g., “Doe”).
Email string Yes The user’s unique email address.
Phone string No The user’s phone number, useful for contact and notifications.
IsAllowedToPublish boolean No Indicates whether the user can publish job offers. Defaults to false if not specified.
IsRequestManager boolean No Determines if the user is a Request Manager. Grants authority to request new job vacancies. Defaults to false.
IsOnboardingManager boolean No Enables access to the Admission section and admission process configuration. Defaults to false if not specified.
IsAllowedToRequest boolean No Grants the ability to create requests (e.g., submitting proposals). Defaults to false.
IsAllowedToChangeRequestFlow boolean No Allows altering the request process or flow (e.g., changing statuses). Defaults to false.
IsAllowedToOverrideRequest boolean No Lets the user override requests. Defaults to false.
IsAllowedToPrime boolean No Provides an additional privilege level, such as final approvals. Defaults to false.
Note: The IsOnboardingManager permission enables access to the Admission section and the configuration of the admission process. To grant this permission, the user must also hold one of the following roles: UserRole.Company_Administrator, UserRole.Company_Supervisor, or UserRole.Company_Manager.

 

Example request

POST /v2/company/users
Content-Type: application/json

{
  "Name": "Jane",
  "Surname": "Doe",
  "Email": "jane.doe@example.com",
  "Phone": "555-1234",
  "IsAllowedToPublish": true,
  "IsRequestManager": true,
  "IsOnboardingManager": false,
  "IsAllowedToRequest": true,
  "IsAllowedToChangeRequestFlow": false,
  "IsAllowedToOverrideRequest": false,
  "IsAllowedToPrime": false
}

 

What this does:

  • Creates a user named “Jane Doe” with the email jane.doe@example.com.
  • Allows her to publish and manage requests, and also to create her own requests.
  • She is not an onboarding manager, nor can she change request flows, override requests, or perform “prime” actions.

 

Responses

Status Code Meaning Response body
200 Success Returns a JSON object with details of the newly created user.
401 Unauthorized The request could not be completed due to invalid authentication credentials.
403 Forbidden The request was understood but refused due to insufficient privileges.

 

Error Handling

  • 401 Unauthorized: Ensure your token or credentials are still valid.
  • 403 Forbidden: You do not have the necessary permissions to create users.

 

Tips & Best Practices

  • Default privileges: Some fields may default to true (making the user an admin or giving them high-level privileges). Confirm the default values in your environment and explicitly set any privileges you do not want to enable.
  • Duplicate emails: Ensure the email address is not already used by another user in your Pandapé account.

For more information, please consult the Pandapé API v2 documentation.

Related articles