Update an API key
Updates the label of an existing API key. Scopes are immutable after creation — revoke and create a new key to change scopes. Requires OAuth2 Bearer token.
Updates the label of an existing API key. Scopes are immutable after creation — revoke and create a new key to change scopes.
Requires OAuth2 Bearer token.
Authorization
oauth2 OAuth2 Authorization Code flow. Used for dashboard-integrated flows and API key management endpoints.
In: header
Path Parameters
UUID of the API key.
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
New human-readable label for this key.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/settings/api-keys/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"keyPrefix": "string",
"label": "string",
"scopes": [
"string"
],
"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"revokedAt": "2019-08-24T14:15:22Z",
"lastUsedAt": "2019-08-24T14:15:22Z",
"active": true
}{
"status": 401,
"error": "UNAUTHORIZED",
"message": "Invalid or missing API key",
"timestamp": "2026-05-17T12:00:00Z",
"path": "/public/v1/job-listings"
}{
"status": 404,
"error": "NOT_FOUND",
"message": "Job listing not found",
"timestamp": "2026-05-17T12:00:00Z",
"path": "/public/v1/job-listings/00000000-0000-0000-0000-000000000000"
}Create an API key POST
Generates a new API key with the specified label and scopes. The `rawKey` in the response is the only time the full key is returned — store it securely. Requires OAuth2 Bearer token.
Revoke an API key DELETE
Immediately revokes an API key. Any subsequent requests using this key will receive `401 Unauthorized`. Requires OAuth2 Bearer token.