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.

Body

Set recurrence, start, and end. Dates and times are local to the organization's timezone; an all-day closure runs from 00:00 on its first day to 24:00 on its last day. Omit enabled to create an enabled closure.

description
string
required

Closure name or reason shared with callers and visitors.

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

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

end
object
required

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
required

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

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

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