Vault

get
Authorizations
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
GET /api/unified-communications/vault HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:47:42.528Z",
      "updated_at": "2025-07-23T12:47:42.528Z",
      "name": "text",
      "thumbnail": "https://example.com",
      "url": "https://example.com",
      "size": 1,
      "duration": "text",
      "type": "audio",
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}
post
Authorizations
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 | 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
201Success
application/json
post
POST /api/unified-communications/vault HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "name": "text",
  "thumbnail": "https://example.com",
  "url": "https://example.com",
  "size": 1,
  "duration": "text",
  "type": "audio"
}
201Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:47:42.528Z",
  "updated_at": "2025-07-23T12:47:42.528Z",
  "name": "text",
  "thumbnail": "https://example.com",
  "url": "https://example.com",
  "size": 1,
  "duration": "text",
  "type": "audio",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}
get
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this church media.

Responses
200Success
application/json
get
GET /api/unified-communications/vault/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:47:42.528Z",
  "updated_at": "2025-07-23T12:47:42.528Z",
  "name": "text",
  "thumbnail": "https://example.com",
  "url": "https://example.com",
  "size": 1,
  "duration": "text",
  "type": "audio",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}
put
Authorizations
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 | 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
200Success
application/json
put
PUT /api/unified-communications/vault/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "name": "text",
  "thumbnail": "https://example.com",
  "url": "https://example.com",
  "size": 1,
  "duration": "text",
  "type": "audio"
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:47:42.528Z",
  "updated_at": "2025-07-23T12:47:42.528Z",
  "name": "text",
  "thumbnail": "https://example.com",
  "url": "https://example.com",
  "size": 1,
  "duration": "text",
  "type": "audio",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}
delete
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this church media.

Responses
204
No response body
delete
DELETE /api/unified-communications/vault/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
204

No response body

No content
patch
Authorizations
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 | 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
200Success
application/json
patch
PATCH /api/unified-communications/vault/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "name": "text",
  "thumbnail": "https://example.com",
  "url": "https://example.com",
  "size": 1,
  "duration": "text",
  "type": "audio"
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:47:42.528Z",
  "updated_at": "2025-07-23T12:47:42.528Z",
  "name": "text",
  "thumbnail": "https://example.com",
  "url": "https://example.com",
  "size": 1,
  "duration": "text",
  "type": "audio",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}
PreviousSmart keyword hitNextDelete