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
chevron-right
200Success
application/json
get
/api/unified-communications/vault
200Success
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 · enumRequired
  • audio - Audio
  • image - Image
  • video - Video
Possible values:
churchstring · uuidRead-onlyRequired
Responses
post
/api/unified-communications/vault
201Success
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this church media.

Responses
chevron-right
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 · enumRequired
  • audio - Audio
  • image - Image
  • video - Video
Possible values:
churchstring · uuidRead-onlyRequired
Responses
chevron-right
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
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 · enumOptional
  • audio - Audio
  • image - Image
  • video - Video
Possible values:
churchstring · uuidRead-onlyOptional
Responses
chevron-right
200Success
application/json
patch
/api/unified-communications/vault/{id}
200Success