Contact preferences

get

Authorizations

jwtAuth

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/contact-preferences

HTTPcURLJavaScriptPython

GET /api/unified-communications/contact-preferences HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
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",
      "user": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T05:10:06.405Z",
      "updated_at": "2026-02-17T05:10:06.405Z",
      "contact": "text",
      "reason": "text",
      "country": "text",
      "do_not_text": true,
      "do_not_call": true,
      "do_not_email": 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 · nullableOptional

updated_atstring · date-timeRead-onlyRequired

contactstring · max: 255Required

reasonstring · nullableOptional

Reason for the restriction.

countrystring · max: 255 · nullableOptional

do_not_textbooleanOptional

do_not_callbooleanOptional

do_not_emailbooleanOptional

Responses

201Success

application/json

post

/api/unified-communications/contact-preferences

HTTPcURLJavaScriptPython

POST /api/unified-communications/contact-preferences 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",
  "created_at": "2026-02-17T05:10:06.405Z",
  "contact": "text",
  "reason": "text",
  "country": "text",
  "do_not_text": true,
  "do_not_call": true,
  "do_not_email": true
}

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

201Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T05:10:06.405Z",
  "updated_at": "2026-02-17T05:10:06.405Z",
  "contact": "text",
  "reason": "text",
  "country": "text",
  "do_not_text": true,
  "do_not_call": true,
  "do_not_email": true
}

get

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this contact preference.

Responses

200Success

application/json

get

/api/unified-communications/contact-preferences/{id}

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T05:10:06.405Z",
  "updated_at": "2026-02-17T05:10:06.405Z",
  "contact": "text",
  "reason": "text",
  "country": "text",
  "do_not_text": true,
  "do_not_call": true,
  "do_not_email": true
}

put

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this contact preference.

Body

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

idstring · uuidRead-onlyRequired

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-timeRead-onlyRequired

contactstring · max: 255Required

reasonstring · nullableOptional

Reason for the restriction.

countrystring · max: 255 · nullableOptional

do_not_textbooleanOptional

do_not_callbooleanOptional

do_not_emailbooleanOptional

Responses

200Success

application/json

put

/api/unified-communications/contact-preferences/{id}

HTTPcURLJavaScriptPython

PUT /api/unified-communications/contact-preferences/{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",
  "created_at": "2026-02-17T05:10:06.405Z",
  "contact": "text",
  "reason": "text",
  "country": "text",
  "do_not_text": true,
  "do_not_call": true,
  "do_not_email": true
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T05:10:06.405Z",
  "updated_at": "2026-02-17T05:10:06.405Z",
  "contact": "text",
  "reason": "text",
  "country": "text",
  "do_not_text": true,
  "do_not_call": true,
  "do_not_email": true
}

delete

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this contact preference.

Responses

204

No response body

delete

/api/unified-communications/contact-preferences/{id}

HTTPcURLJavaScriptPython

DELETE /api/unified-communications/contact-preferences/{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 preference.

Body

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

idstring · uuidRead-onlyOptional

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-timeRead-onlyOptional

contactstring · max: 255Optional

reasonstring · nullableOptional

Reason for the restriction.

countrystring · max: 255 · nullableOptional

do_not_textbooleanOptional

do_not_callbooleanOptional

do_not_emailbooleanOptional

Responses

200Success

application/json

patch

/api/unified-communications/contact-preferences/{id}

HTTPcURLJavaScriptPython

PATCH /api/unified-communications/contact-preferences/{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",
  "created_at": "2026-02-17T05:10:06.405Z",
  "contact": "text",
  "reason": "text",
  "country": "text",
  "do_not_text": true,
  "do_not_call": true,
  "do_not_email": true
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T05:10:06.405Z",
  "updated_at": "2026-02-17T05:10:06.405Z",
  "contact": "text",
  "reason": "text",
  "country": "text",
  "do_not_text": true,
  "do_not_call": true,
  "do_not_email": true
}