Privileged and Confidential This endpoint design has been confidentially shared with you. It is still under development and is subject to change without notice. Please do not share this document or API endpoint details with anyone who is not authorized to have access. For more information read about scopes.
Use Case
The Create Organization endpoint allows you to create a new organization.
Authorization
The Create Organization endpoint requires an access_token using the client credentials (for 1P use-case) grant to business.organizations
scope.
If an application follows third party authentication, the create organization endpoint requires the client to get authorized using the authorization endpoint
Request Parameters
Name |
Type |
Description |
organization |
object |
An object containing the organization information |
organization.name |
string |
Name of the organization. |
organization.home_country_iso |
string |
Home country of the organization. |
organization.billing_mode |
string |
Billing mode for the organization. Accepted values are: CENTRALIZED, DECENTRALIZED. Default value is “CENTRALIZED” |
admin |
string |
An object containing details of the organization admin. |
admin.first_name |
string |
First name of the employee with an admin role. |
admin.last_name |
string |
Last name of the employee with an admin role. |
admin.email |
string |
Email id of the employee. |
admin.mobile_country_code |
string |
(Optional) The mobile country code of the employee. |
admin.mobile_number |
string |
(Optional) The mobile number of the employee. |
consents_accepted |
bool |
A boolean to record whether the admin has signed the consents or not. |
u4b_products |
array |
(Optional) An array containing products the organization should be created with. Accepted values are: RIDES, EATS, GUESTS, VOUCHERS, HEALTH. |
Accepted U4B Products
Name |
Description |
RIDES |
Add rides program to the organization. Allow employees to take trips on business profile. |
EATS |
Add eats program to the organization. Allow employees to book uber eats orders on business profile. |
VOUCHERS |
Add vouchers program to the organization. Allow organization to create vouchers. |
GUESTS |
Add Uber Central program to the organization. Allow organization to use Uber Central. |
HEALTH |
Add Uber Health program to the organization. Allow organization to use Uber Health. |
Accepted Organization Billing Modes
Name |
Description |
CENTRALIZED |
Centralized organizations take advantage of the Uber for Business “one pays for many” feature where organizations pay directly for all of their employee trips |
DECENTRALIZED |
Employees in a decentralized organization pay for their own trips using their corporate card. |
Response Fields
Name |
Type |
Description |
organization |
object |
An object containing the organization information |
organization.uuid |
string |
Unique identifier of the organization. |
organization.name |
string |
Name of the organization. |
organization.home_country_iso |
string |
Home country of the organization. |
organization.status |
string |
Status of the organization. Can be ACTIVE or INACTIVE. |
organization.billing_mode |
string |
Billing mode for an organization. Can be CENTRALIZED or DECENTRALIZED. |
Example Request
curl -X POST 'https://api.uber.com/v1/organizations'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer <TOKEN>
-d '{
"organization": {
"name": "test org",
"home_country_iso": "US",
"billing_mode": "CENTRALIZED"
},
"admin": {
"first_name": "abc",
"last_name": "def",
"email": "abc@gmail.com"
},
"u4b_products": ["RIDES"],
"consents_accepted": true
}'
Example Response
If the organization was successfully created:
Status-Code: 200 OK
{
"organization": {
"uuid": "8c01cfed-eba5-46ec-8ab3-3181e47dffd8",
"name": "test org",
"home_country_iso": "US",
"status": "INACTIVE",
"billing_mode": "CENTRALIZED"
}
}
Error Responses
HTTP Status |
Code |
Description |
400 |
BAD_REQUEST |
request specific message |
401 |
NOT_AUTHORIZED |
Caller not authorized to make this request |
500 |
INTERNAL_SERVER_ERROR |
We have experienced a problem |