Skip to content
Linra Omni Vendor Docs

Set own vendor credential active

Activate or deactivate one of your own API credentials.

Credentials

PATCH/api/v1/credentials/{id}/active

Sets a credential’s active state. A credential belonging to another vendor is reported as 404 — indistinguishable from a nonexistent one. Requires the Account capability.

Path parameters

idstring (uuid)Required

The credential id.

Body parameters

isActivebooleanRequired

Required. true activates, false deactivates. A body without isActive returns 400 VALIDATION_ERRORS and changes nothing.

Response

idstring (uuid)
environmentstring
clientIdstring
capabilitiesstring

A comma-separated combination of one or more granted capabilities, drawn from the fixed set Offers, Stock, Cost, Orders, Account. Offers/Stock/Cost/Orders gate the commercial doors (Offers/Cost/Stock/Orders/Webhooks) as documented on each operation. Account gates the credentials-write door (generate/activate-deactivate/delete) — the corresponding reads (list credentials, get profile) require no capability at all. (Not a single-value enum here — a real value is a COMBINATION of one or more of these five names, comma-joined, e.g. the example below.)

expirationDatestring (date-time)
isActiveboolean
createdAtstring (date-time)

Other responses

401No bearer token (UNAUTHORIZED_MISSING_TOKEN), an invalid token (UNAUTHORIZED_INVALID_TOKEN) or an expired one (UNAUTHORIZED_TOKEN_EXPIRED — mint a new token). UPSTREAM_AUTH_FAILED is different: a dependent service refused the Gateway itself. That is a server-side fault — retry later and do NOT re-mint your token. See the Rate limits & errors guide.
403Your token doesn’t carry the capability this endpoint requires.
404Unknown credential id, or one belonging to another vendor.
415The request body is not sent as application/json (UNSUPPORTED_MEDIA_TYPE).
429Too many requests. Retry after the Retry-After header (seconds).
502A dependent service returned an invalid response (BAD_GATEWAY). Retry with backoff.
503The service is temporarily unavailable (SERVICE_UNAVAILABLE). Retry with backoff.
504A dependent service did not respond in time (GATEWAY_TIMEOUT). Retry with backoff.
curl --request PATCH \
--url https://api-omni-vendors.linra.net/api/v1/credentials/5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b/active \
--header 'Authorization: Bearer $TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"isActive": true
}'

Response

{
"state": "SUCCESS",
"payload": {
"id": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
"environment": "Production",
"clientId": "string",
"capabilities": "Offers, Cost",
"expirationDate": "2026-08-22T09:14:03Z",
"isActive": true,
"createdAt": "2026-08-22T09:14:03Z"
},
"details": null
}