Create Exchange

post

https://www.keycafe.com/v0/exchange

Create an exchange with a POST request to the endpoint.

Body Params

type

string

required

The exchange type (PICKUP/DROPOFF/ACTIVATION).

key

object

required

The key for which the exchange is being performed.

user

object

The user who is performing the exchange. If omitted, the authenticated user is used. If another user is specified for a drop off, a location must also be specified. If another user is specified, the authenticated user must be the owner of both the key and the location network. Can be specified by user ID, email or mobile.

location

object

The location at which the exchange is being performed. Required for activations. Optional for dropping off. If omitted for a drop off, the key's home location will be used to determine if API exchanges are available. For pickups, the location property is ignored and the key's current location is used.

Response

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Exchange successfully created.