Activate or deactivate a webhook subscription
PATCH
/api/v1/webhooks/{id}/active
const url = 'https://api-omni.linra.net/api/v1/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/active';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"isActive":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api-omni.linra.net/api/v1/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/active \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "isActive": true }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
isActive
required
boolean
Examplegenerated
{ "isActive": true}Responses
Section titled “Responses”The new status.
Media typeapplication/json
object
state
required
string
payload
required
details
object
payload
required
object
id
string format: uuid
isActive
boolean
Example
{ "state": "SUCCESS"}Unknown subscription.
Media typeapplication/json
The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).
object
state
required
string
payload
required
Always null on an error response.
object
details
object
Example
{ "state": "NOT_FOUND_ORDER", "payload": null}Too many requests — see the Rate limits guide. Retry after the Retry-After header (seconds).
Media typeapplication/json
The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).
object
state
required
string
payload
required
Always null on an error response.
object
details
object
Example
{ "state": "NOT_FOUND_ORDER", "payload": null}Headers
Section titled “Headers”Retry-After
integer
Seconds to wait before retrying.