Vault
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageintegerOptional
A page number within the paginated result set.
page_sizeintegerOptional
Number of results to return per page.
Responses
200Success
application/json
get
/api/unified-communications/vault200Success
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstring · uuidRead-onlyRequired
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableRead-onlyRequired
updated_atstring · date-timeRead-onlyRequired
namestring · max: 100Required
thumbnailstring · uri · max: 100 · nullableOptional
urlstring · uri · max: 200Required
sizeinteger · int64 · min: -9223372036854776000 · max: 9223372036854776000Optional
durationstring · decimalOptionalPattern:
^-?\d{0,6}(?:\.\d{0,2})?$typestring · enumRequiredPossible values:
audio- Audioimage- Imagevideo- Video
churchstring · uuidRead-onlyRequired
Responses
201Success
application/json
post
/api/unified-communications/vault201Success
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
A UUID string identifying this church media.
Responses
200Success
application/json
get
/api/unified-communications/vault/{id}200Success
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
A UUID string identifying this church media.
Body
idstring · uuidRead-onlyRequired
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableRead-onlyRequired
updated_atstring · date-timeRead-onlyRequired
namestring · max: 100Required
thumbnailstring · uri · max: 100 · nullableOptional
urlstring · uri · max: 200Required
sizeinteger · int64 · min: -9223372036854776000 · max: 9223372036854776000Optional
durationstring · decimalOptionalPattern:
^-?\d{0,6}(?:\.\d{0,2})?$typestring · enumRequiredPossible values:
audio- Audioimage- Imagevideo- Video
churchstring · uuidRead-onlyRequired
Responses
200Success
application/json
put
/api/unified-communications/vault/{id}200Success
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
A UUID string identifying this church media.
Responses
204
No response body
delete
/api/unified-communications/vault/{id}204
No response body
No content
patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
A UUID string identifying this church media.
Body
idstring · uuidRead-onlyOptional
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
namestring · max: 100Optional
thumbnailstring · uri · max: 100 · nullableOptional
urlstring · uri · max: 200Optional
sizeinteger · int64 · min: -9223372036854776000 · max: 9223372036854776000Optional
durationstring · decimalOptionalPattern:
^-?\d{0,6}(?:\.\d{0,2})?$typestring · enumOptionalPossible values:
audio- Audioimage- Imagevideo- Video
churchstring · uuidRead-onlyOptional
Responses
200Success
application/json
patch
/api/unified-communications/vault/{id}200Success