API Reference

Create Alias Code

post
https://www.keycafe.com/v0/aliasCode

Create an alias code with a POST request to the endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The post body should contain the necessary data to create the alias code as a JSON object:

{
    "code": "123456",
    "location": {
        "id": 123456
    }
}
Body Params
string
required

The code to be used by the visitor at the location. Must be distinct from any other codes at the location.

location
object
required

The private location the alias code will be used at. Only the ID property is necessary.

access
object

The access linked to the alias code. Only the ID property is necessary. Can be omitted, but the alias code won't be usable until an access is provided.

Response

Updated 11 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago