Contacts

get
Authorizations
Query parameters
limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
200Success
application/json
get
GET /api/unified-communications/contacts HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:27:03.659Z",
      "updated_at": "2025-07-23T12:27:03.659Z",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "[email protected]",
      "avatar": "https://example.com",
      "is_manual": true
    }
  ]
}
post
Authorizations
Body
idstring · uuidRead-onlyRequired
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableRead-onlyRequired
updated_atstring · date-timeRead-onlyRequired
first_namestring · max: 50Required
middle_namestring | nullableOptional
last_namestring · max: 50Required
phonestring · max: 15Required
emailstring · email · max: 254Required
avatarstring · uri | nullableOptional
is_manualbooleanOptional
Responses
201Success
application/json
post
POST /api/unified-communications/contacts HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "phone": "text",
  "email": "[email protected]",
  "avatar": "https://example.com",
  "is_manual": true
}
201Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:27:03.659Z",
  "updated_at": "2025-07-23T12:27:03.659Z",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "phone": "text",
  "email": "[email protected]",
  "avatar": "https://example.com",
  "is_manual": true
}
get
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this contact.

Responses
200Success
application/json
get
GET /api/unified-communications/contacts/{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:27:03.659Z",
  "updated_at": "2025-07-23T12:27:03.659Z",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "phone": "text",
  "email": "[email protected]",
  "avatar": "https://example.com",
  "is_manual": true
}
put
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this contact.

Body
idstring · uuidRead-onlyRequired
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableRead-onlyRequired
updated_atstring · date-timeRead-onlyRequired
first_namestring · max: 50Required
middle_namestring | nullableOptional
last_namestring · max: 50Required
phonestring · max: 15Required
emailstring · email · max: 254Required
avatarstring · uri | nullableOptional
is_manualbooleanOptional
Responses
200Success
application/json
put
PUT /api/unified-communications/contacts/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "phone": "text",
  "email": "[email protected]",
  "avatar": "https://example.com",
  "is_manual": true
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:27:03.659Z",
  "updated_at": "2025-07-23T12:27:03.659Z",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "phone": "text",
  "email": "[email protected]",
  "avatar": "https://example.com",
  "is_manual": true
}
delete
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this contact.

Responses
204
No response body
delete
DELETE /api/unified-communications/contacts/{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 contact.

Body
idstring · uuidRead-onlyOptional
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
first_namestring · max: 50Optional
middle_namestring | nullableOptional
last_namestring · max: 50Optional
phonestring · max: 15Optional
emailstring · email · max: 254Optional
avatarstring · uri | nullableOptional
is_manualbooleanOptional
Responses
200Success
application/json
patch
PATCH /api/unified-communications/contacts/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "phone": "text",
  "email": "[email protected]",
  "avatar": "https://example.com",
  "is_manual": true
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:27:03.659Z",
  "updated_at": "2025-07-23T12:27:03.659Z",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "phone": "text",
  "email": "[email protected]",
  "avatar": "https://example.com",
  "is_manual": true
}
PreviousDo not textNextMessage transactions