Skip to main content
POST
Update closure

Path Parameters

orgId
string<uuid>
required

Organization ID.

closureId
string<uuid>
required

Closure ID.

Body

Supply either annualDate for an annual all-day closure, or both startAt and endAt for a one-time closure. Do not combine them.

description
string
required

Closure name or reason shared with callers and visitors.

Required string length: 1 - 255
Pattern: \S
startAt
string<date-time>

When the closure begins, inclusive. UTC timestamp in YYYY-MM-DDTHH:mm:00Z format; no fractional seconds.

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:00Z$
Example:

"2026-12-24T18:30:00.000Z"

endAt
string<date-time>

When the closure ends, exclusive. Must be after startAt. UTC timestamp in YYYY-MM-DDTHH:mm:00Z format; no fractional seconds.

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:00Z$
Example:

"2026-12-24T18:30:00.000Z"

annualDate
object

Repeat on this calendar date each year for the entire day in the organization's timezone.

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

Response

Response for status 200

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