Contacts

get

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

/api/unified-communications/contacts

HTTPcURLJavaScriptPython

GET /api/unified-communications/contacts HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
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": "2026-02-17T03:49:35.894Z",
      "updated_at": "2026-02-17T03:49:35.894Z",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "[email protected]",
      "avatar": "https://example.com",
      "is_manual": true
    }
  ]
}

post

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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 · max: 50 · nullableOptional

last_namestring · max: 50Required

phonestring · max: 15Required

emailstring · email · max: 254Required

avatarstring · uri · max: 200 · nullableOptional

is_manualbooleanOptional

Responses

201Success

application/json

post

/api/unified-communications/contacts

HTTPcURLJavaScriptPython

POST /api/unified-communications/contacts HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
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
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T03:49:35.894Z",
  "updated_at": "2026-02-17T03:49:35.894Z",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "phone": "text",
  "email": "[email protected]",
  "avatar": "https://example.com",
  "is_manual": true
}

get

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this contact.

Responses

200Success

application/json

get

/api/unified-communications/contacts/{id}

HTTPcURLJavaScriptPython

GET /api/unified-communications/contacts/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T03:49:35.894Z",
  "updated_at": "2026-02-17T03:49:35.894Z",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "phone": "text",
  "email": "[email protected]",
  "avatar": "https://example.com",
  "is_manual": true
}

put

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this contact.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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 · max: 50 · nullableOptional

last_namestring · max: 50Required

phonestring · max: 15Required

emailstring · email · max: 254Required

avatarstring · uri · max: 200 · nullableOptional

is_manualbooleanOptional

Responses

200Success

application/json

put

/api/unified-communications/contacts/{id}

HTTPcURLJavaScriptPython

PUT /api/unified-communications/contacts/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
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
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T03:49:35.894Z",
  "updated_at": "2026-02-17T03:49:35.894Z",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "phone": "text",
  "email": "[email protected]",
  "avatar": "https://example.com",
  "is_manual": true
}

delete

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this contact.

Responses

204

No response body

delete

/api/unified-communications/contacts/{id}

HTTPcURLJavaScriptPython

DELETE /api/unified-communications/contacts/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No response body

No content

patch

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this contact.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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 · max: 50 · nullableOptional

last_namestring · max: 50Optional

phonestring · max: 15Optional

emailstring · email · max: 254Optional

avatarstring · uri · max: 200 · nullableOptional

is_manualbooleanOptional

Responses

200Success

application/json

patch

/api/unified-communications/contacts/{id}

HTTPcURLJavaScriptPython

PATCH /api/unified-communications/contacts/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
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
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T03:49:35.894Z",
  "updated_at": "2026-02-17T03:49:35.894Z",
  "first_name": "text",
  "middle_name": "text",
  "last_name": "text",
  "phone": "text",
  "email": "[email protected]",
  "avatar": "https://example.com",
  "is_manual": true
}