Update Keycard
PATCH
/keycards/{keycardId}
Update a keycard
Parameters
Header Parameters
compatibility-date*
API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.
Type
Requiredstring
Example
"2025-11-02"Pattern
^\d{4}-\d{2}-\d{2}$organization-id*
Routes the request to the organization named by this ID. The bearer token must be authorized for that organization.
Type
Requiredstring
Example
"3b241101-e2bb-4255-8caf-4136c566a962"Min Length
1Max Length
40Path Parameters
keycardId*
Type
Requiredstring
Request Body
application/json
Human-readable identifier for the keycard; keycards created from a template carry the friendly ID printed on the card.
Restricts where the keycard can be used; the bound entity must belong to the keycard organization.
| Binding | Effect |
|---|---|
chargerId |
The keycard can only be used at this charger. |
locationId |
The keycard can only be used at chargers installed at this location. |
organizationId |
The keycard can only be used at chargers of this organization. |
Group the keycard belongs to; organization settings can allow same-group keycards to stop a session started with this keycard.
Responses
success.keycard.update
application/json