Skip to the page

Praecise Platform

Rivier/ Reference/ bookings

Pause or resume a channel connection

put/lodging/channels/{id}/status

Before you call

Credential: Authorization: Bearer $KEY
Scope: bookings:admin
Sdk: bookings.channel.setStatus
Cli: bookings channel set status

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

statusstringrequired
One of: active, paused.

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X PUT 'https://api.rivier.ai/lodging/channels/{id}/status' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": "active"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown