Skip to content
Linra Omni Vendor Docs

Activate or deactivate one of your own API credentials

PATCH
/api/v1/credentials/{id}/active
curl --request PATCH \
  --url https://api-omni-vendors.linra.net/api/v1/credentials/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/active \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "isActive": true }'

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.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

The credential id.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
isActive
required
boolean
Examplegenerated
{
  "isActive": true
}

Responses

Section titled “Responses”

200

Section titled “200”

The updated credential.

Media typeapplication/json
object
state
required
string
payload
required
details
object
payload
required

Never exposes a secret — the raw secret is only ever returned once, at generation time, via VendorCredentialGeneratedResponse.

object
id
string format: uuid
vendorId
string format: uuid
environment
string
clientId
string
capabilities

A comma-separated combination of one or more granted capabilities: Offers, Stock, Cost, Orders, Account. Account gates the Profile-update and Credentials-write endpoints on this document; the other four gate the commercial (Offers/Cost/Stock/Orders/Webhooks) endpoints as documented on each operation.

string
expirationDate
string format: date-time
nullable
isActive
boolean
createdAt
string format: date-time
nullable
Example
{
  "state": "SUCCESS",
  "payload": {
    "environment": "Production",
    "capabilities": "Offers, Cost"
  }
}

403

Section titled “403”

Your token doesn’t carry the capability this endpoint requires.

Media typeapplication/json
object
state
required
string
payload
details
object
Examples
ExamplemissingCapability
{
  "state": "FORBIDDEN_CAPABILITY_NOT_GRANTED",
  "payload": null,
  "details": {
    "requiredCapability": "Orders"
  }
}

404

Section titled “404”

Unknown credential id, or one belonging to another vendor.

Media typeapplication/json
object
state
required
string
payload
details
object
Examples
ExamplenotFound
{
  "state": "NOT_FOUND_VENDOR_CREDENTIAL",
  "payload": null,
  "details": {}
}

429

Section titled “429”

Too many requests. Retry after the Retry-After header (seconds).

Media typeapplication/json
object
state
required
string
payload
details
object
Example
{
  "state": "NOT_FOUND_VENDOR_OFFER"
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before retrying.