Update a recording

Update a recording

Path Parameters

id string required

The ID of the recording to update

application/json

Request Body

name string

Name of the recording

description string

Description of the recording

Responses

• 204
• 400
• 401
• 404
• 500

---

Successfully updated the recording

Bad request

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
code string
Human readable error code
message string
Human readable error message
detail string
Human readable error detail
]

{
  "errors": [
    {
      "code": "ERROR_CODE",
      "message": "An error occurred while calling the endpoint",
      "detail": "View more info at developers.rinkel.com"
    }
  ]
}

Unauthorized

The recording was not found

Internal Server Error

PATCH /recordings/:id

Authorization

name: x-rinkel-api-keytype: apiKeyin: header

Request

Base URL

https://api.rinkel.com/v1

apiKeyAuth

id — path required

Body

{
  "name": "Recording 1",
  "description": "This is a recording"
}

curl / cURL

curl -L -X PATCH 'https://api.rinkel.com/v1/recordings/:id' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "name": "Recording 1",
  "description": "This is a recording"
}'

nodejs / axios

curl -L -X PATCH 'https://api.rinkel.com/v1/recordings/:id' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "name": "Recording 1",
  "description": "This is a recording"
}'

php / axios

curl -L -X PATCH 'https://api.rinkel.com/v1/recordings/:id' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "name": "Recording 1",
  "description": "This is a recording"
}'

python / requests

curl -L -X PATCH 'https://api.rinkel.com/v1/recordings/:id' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "name": "Recording 1",
  "description": "This is a recording"
}'

ruby / cURL

curl -L -X PATCH 'https://api.rinkel.com/v1/recordings/:id' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "name": "Recording 1",
  "description": "This is a recording"
}'

java / unirest

curl -L -X PATCH 'https://api.rinkel.com/v1/recordings/:id' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "name": "Recording 1",
  "description": "This is a recording"
}'