Skip to navigation

Update a location

View as Markdown

Renames a location and changes or removes its client_reference_id.

Scope: customers:write.

Authentication

AuthorizationBearer

A restricted API key, tc_rk_live_ and 32 characters. Send it as Authorization: Bearer <key>. A key lists its scopes, and each operation below names the one it needs; a key may also be limited to one customer. An owner or a developer of the organization makes a key in the dashboard, under API keys, after a code sent to their e-mail. The key is shown once, when it is made. An owner or a developer can revoke it there, and a revoked key stops working within a minute.

Path parameters

locationstringRequired
The location's id.

Request

This endpoint expects an object.
client_reference_idstring or nullOptional
namestring or nullOptional

Response

The location as it is now.
client_reference_idstring or null
created_atstring
customerstring
The id of the customer the location belongs to.
idstring
namestring
objectstring
printer_countlong>=0
statestring

active, or suspended (paused).

addressstring or nullOptional

Only in the answer to a single location; lists leave it out.

timezonestring or nullOptional
An IANA time zone name. Only in the answer to a single location.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error