Skip to main content
PATCH
Update Announcement

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Announcement ID

Pattern: ^[1-9]\d*$

Body

application/json
name
string
description
string
mediaFileId
number
active
Available options:
0
startDate
string
endDate
string
ivrIds
number[]
branchId
number

Response

200 - application/json

Updated announcement

id
number
required

Announcement ID

tenantId
number
required

Tenant ID

name
string
required

Announcement name

description
string
required

Announcement description

mediaFile
object | null
required

Attached media file

active
number
required

Active state (1 = active, 0 = inactive)

startDate
string
required

Start date (ISO 8601)

endDate
string
required

End date (ISO 8601)

ivrs
object[]
required

IVRs this announcement is attached to

branch
object
required

Owning branch