Uber Developers

Uber

Developers

Invite Employees

POSThttps://api.uber.com/v1/business/organizations/{organization_id}/employees/invite

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 Invite Employees endpoint allows you to invite employees of an organization. Note - Currently, we support sending invite to only a single employee of an organization. Also, this API is available for only select 3P partners

¶ Authorization

The Invite Employees endpoint requires an access_token using the client credentials (for 1P use-case) grant to business.employees scope.

If an application follows third party authentication, the invite employees endpoint requires the client to get authorized using the authorization endpoint

¶ Path Parameters

Name	Type	Optional	Description
`organization_id`	string	No	Identifier for your organization.

¶ Request Parameters

Name	Type	Optional	Description
`employeeParams`	array	No	A list of employeeParam object
`employeeParams[].email`	string	No	Email of the employee to send the invite to

¶ Response Fields

Name	Type	Description
`failures`	array	A list of failure objects.
`failures[].email`	string	Email of the employee for which invite failed.

¶ Example Request

curl -X POST "https://api.uber.com/v1/business/organizations/<organization_id>/employees/invite" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <TOKEN>" \
-d '{
      "employeeParams": [
        "email": "testnew@xyz.com"
      ]
    }'

¶ Example Response

Status-Code: 200 OK

{
 "failures": [
 ]
}

¶ Error Responses

HTTP Status	Code	Description
400	`BAD_REQUEST`	request specific message
401	`NOT_AUTHORIZED`	Caller not authorized to make this request
404	`NOT_FOUND`	No employees from employeeParams were found
429	`rate_limited`	Rate limit exceeded
500	`INTERNAL_SERVER_ERROR`	We have experienced a problem

Uber

Developers