Skip to content
Cordboard Documentation

Set box options (merge-patch)

PUT
/v1/ns/{nsid}/vm/boxes/{context}/{box}/opts
curl --request PUT \
  --url https://example.com/v1/ns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/vm/boxes/example/example/opts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "additionalProperty": "example" }'

Merge-patch map of option→value. A key that is absent is left unchanged. Recognized keys:

  • email (string): notification address; a null/blank value clears it.
  • temp_greeting_active (“true”/“false”): activate or deactivate the recorded temp (“vacation”) greeting on the subscriber’s behalf. Activating a box that has no recorded temp greeting returns 409.
  • envelope_autoplay (“true”/“false”): per-box override of the context-level envelope-autoplay default. Boolean options have no “clear” state — a null/non-boolean value returns 400. Unknown keys return 400. Validation runs before any write, so a rejected request applies nothing.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
nsid
required
string format: uuid

Namespace UUID

context
required
string
box
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
key
additional properties
string
nullable
Examplegenerated
{
  "additionalProperty": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
success
required
boolean
Example
{
  "success": true
}

default

Section titled “default”

Error response

Media typeapplication/problem+json

RFC 7807 Problem Details

object
type

Problem type slug URI

string
title
string
status
integer
detail
string
key
additional properties
any
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}