Activate or deactivate a webhook subscription

PATCH

/api/v1/vendor/webhooks/{id}/active

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

• Production (placeholder domain — the vendor Gateway facade is not yet deployed to this host; see the Getting started guide)
• Staging (placeholder domain)
• Local development (Gateway default port)

An inactive subscription receives no deliveries and does not count toward the active-subscription cap. Requires the Orders capability.

Authorizations

• vendorBearer

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

isActive

required

boolean

Example^generated

{
  "isActive": true
}

Responses

200

The new active state.

Media typeapplication/json

object

state

required

string

payload

required

details

object

payload

required

object

id

string format: uuid

isActive

boolean

Example

{
  "state": "SUCCESS"
}

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

Unknown subscription id.

Media typeapplication/json

object

state

required

string

payload

details

object

Examples

ExamplenotFound

{
  "state": "NOT_FOUND_VENDOR_WEBHOOK_SUBSCRIPTION",
  "payload": null,
  "details": {}
}

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

Retry-After

integer

Seconds to wait before retrying.