Uber Developers

Uber

Developers

Add Guests to Voucher Program

POSThttps://api.uber.com/v1/organizations/{organization_id}/voucher-programs/{voucher_program_id}/add-guests

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 Add Guests endpoint allows you to add guests to a given voucher program details.

¶ Authorization

The Add Guests endpoint requires an access_token using the client credentials grant to organizations.voucher_programs scope or using authorization_code to organizations.voucher_programs.delegated scope.

If an application follows third party authentication, this endpoint requires organizations.voucher_programs.aggregator scope with the grant type as client_credentials.

¶ Path Parameters

Name	Type	Optional	Description
`organization_id`	string	No	Identifier for the organization the developer is part of and the entity that owns this voucher program. Should be known to developer when their organization was onboarded to Uber For Business.
`voucher_program_id`	string	No	The `voucher_program_id` returned back in the create voucher program call which identifies the voucher program created.

¶ Request Parameters

Name	Type	Optional	Description
guests	object[]	No	Guest info
guests.email	string	Yes	Email for voucher guest
guests.phone	string	Yes	Phone number for voucher guest
send_notifications	bool	Yes	Flag to send notification to guest. Defaults to TRUE; If this field is not explicitly passed as FALSE then the voucher guest will be sent voucher communications.

¶ Response Fields

Name	Type	Description
guests	object[]	Guest info
guests[].email	string	Email for voucher guest
guests[].phone	string	Phone number for voucher guest

¶ Example Request

curl -H 'Authorization: Bearer <TOKEN>' \
     -H 'Accept-Language: en_US' \
     -H 'Content-Type: application/json' \
     'https://api.uber.com/v1/organizations/<organization_id>/voucher-programs/<voucher_program_id>/add-guests'
     {
       "guests":[
          {"email":"foo@bar.com"},
          {"email":"bar@baz.com"},
          {"phone":"+1-123-456-7890"}
       ]
     }

¶ Example Response

Status-Code: 200 OK

{
    "guests":[
      {"email":"foo@bar.com"},
      {"email":"bar@baz.com"},
      {"phone":"+1-123-456-7890"}
    ]
}

¶ Error Responses

HTTP Status	Code	Description
400	`invalid_request`	This request is invalid
403	`user_not_allowed`	User is not authorized for api access
403	`unauthorized`	Requester not allowed to perform requested action. When the third party app (3P) is not authorized by the U4B organization
404	`resource_not_found`	Voucher program is not found
409	`code_generation_in_progress`	The existing codes for the campaign are not ready yet. Please try again later
500	`internal_server_error`	We have experienced a problem

Uber

Developers