Skip to main content
POST

Authorizations

Authorization
string
header
required

An API key (annie-sk-v2-...) or an OAuth access token, sent as Authorization: Bearer <token>.

Path Parameters

orgId
string<uuid>
required

Organization ID.

closureId
string<uuid>
required

Closure ID.

Body

Send only the fields to change; omitted fields keep their current values. recurrence, start, and end replace the schedule and must be sent together. Set enabled to false to stop a closure from applying without deleting it, and to true to apply it again.

description
string

Closure name or reason shared with callers and visitors.

Required string length: 1 - 255
Pattern: \S
recurrence
enum<string>
Available options:
NONE,
ANNUAL
start
object

When the closure begins, in the organization's timezone.

end
object

When the closure ends, in the organization's timezone. For ANNUAL, an end earlier in the calendar than start falls in the following year.

chatGreeting
string

Nonblank chat greeting during the closure, up to 500 characters.

Required string length: 1 - 500
Pattern: \S
phoneGreeting
string

Nonblank phone greeting during the closure, up to 500 characters.

Required string length: 1 - 500
Pattern: \S
enabled
boolean

Whether the closure applies. A disabled closure keeps its ID, schedule, and greetings but does not close the office or change greetings until it is enabled again.

Response

Response for status 200

success
enum<boolean>
required
Available options:
true
data
object
required