Update the greeting settings

Update the greeting settings

Path Parameters

id string required

The ID of the number to update the greeting settings for

application/json

Request Body required

enabled boolean required

Whether the greeting is enabled

recordingId string nullable

The ID of the recording to use as the greeting

Responses

• 204
• 400
• 401
• 403
• 404

---

Successfully updated the greeting

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

Forbidden

The number was not found

PUT /numbers/:id/dial-plan/v1/greeting

Authorization

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

Request

Base URL

https://api.rinkel.com/v1

apiKeyAuth

id — path required

Body required

{
  "enabled": true,
  "recordingId": "654367fa9ee46392f4b84247"
}

curl / cURL

curl -L -X PUT 'https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/greeting' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "enabled": true,
  "recordingId": "654367fa9ee46392f4b84247"
}'

nodejs / axios

curl -L -X PUT 'https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/greeting' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "enabled": true,
  "recordingId": "654367fa9ee46392f4b84247"
}'

php / axios

curl -L -X PUT 'https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/greeting' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "enabled": true,
  "recordingId": "654367fa9ee46392f4b84247"
}'

python / requests

curl -L -X PUT 'https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/greeting' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "enabled": true,
  "recordingId": "654367fa9ee46392f4b84247"
}'

ruby / cURL

curl -L -X PUT 'https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/greeting' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "enabled": true,
  "recordingId": "654367fa9ee46392f4b84247"
}'

java / unirest

curl -L -X PUT 'https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/greeting' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "enabled": true,
  "recordingId": "654367fa9ee46392f4b84247"
}'