v1

latestOpenAPI 3.0.0Cabify Api support2026-07-264588127.9 KB
Users

Create Users in bulk

Create Users in bulk

post/api/v4/users

Request body

can_manageboolean

Whether User is an admin or regular User

can_order_for_othersboolean

If true, user will be able to order journeys for others

default_charge_codestring

User's Default Charge Code

disabledboolean

Whether the User is enabled or disabled

emailstring email required

Email of User. Must be unique

email_ccstring[]

List of email addresses (for journey related emails only)

employee_codestring

User's Employee Code, useful to map with company's code

localestring

User's Locale. Syntax consists of language two-letter tag which then will be suffixed with Client's country, e.g.: es-ES

mobile_ccstring required

Mobile Country Code. Can be checked here: https://countrycode.org/

mobile_numstring required

Mobile Number of User

namestring required

Name of the User

permission_group_idstring nullable

User's TravelPolicy

send_emailboolean

If true an email will be sent to the user upon creation

surnamestring required

Surname of the User

Example request

[
  {
    "can_manage": false,
    "can_order_for_others": false,
    "disabled": false,
    "email": "john.doe@example.com",
    "mobile_cc": "34",
    "mobile_num": "612345678",
    "name": "John",
    "surname": "Doe"
  }
]

Response

Success

job_idstring required

id of job processing the update. The results will be sent asynchronously to predefined webhooks URL upon job termination

Example response

{
  "job_id": "7e3b1f8a4c92d5e0a6b17c3f"
}