Contact groups

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

HTTPcURLJavaScriptPython

GET /api/unified-communications/contact-groups 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",
      "user_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "manual_contacts": [
        {
          "first_name": "text",
          "middle_name": "text",
          "last_name": "text",
          "phone": "text",
          "email": "[email protected]"
        }
      ],
      "contacts": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "legacy_id": "text",
          "nextgen_legacy_id": "text",
          "created_at": "2025-07-23T12:34:09.364Z",
          "updated_at": "2025-07-23T12:34:09.364Z",
          "first_name": "text",
          "middle_name": "text",
          "last_name": "text",
          "phone": "text",
          "email": "[email protected]",
          "avatar": "https://example.com",
          "is_manual": true
        }
      ],
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:34:09.364Z",
      "updated_at": "2025-07-23T12:34:09.364Z",
      "name": "text",
      "thumbnail": "https://example.com",
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

post

Authorizations

Body

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

idstring · uuidRead-onlyRequired

user_idsstring · uuid[]Optional

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyRequired

namestring · max: 100Required

thumbnailstring · uri | nullableOptional

churchstring · uuidRequired

Responses

201Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/unified-communications/contact-groups HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 357

{
  "user_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "manual_contacts": [
    {
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "[email protected]"
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:34:09.364Z",
  "name": "text",
  "thumbnail": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

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

201Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "manual_contacts": [
    {
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "[email protected]"
    }
  ],
  "contacts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:34:09.364Z",
      "updated_at": "2025-07-23T12:34:09.364Z",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "[email protected]",
      "avatar": "https://example.com",
      "is_manual": true
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:34:09.364Z",
  "updated_at": "2025-07-23T12:34:09.364Z",
  "name": "text",
  "thumbnail": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

get

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this contact group.

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "manual_contacts": [
    {
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "[email protected]"
    }
  ],
  "contacts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:34:09.364Z",
      "updated_at": "2025-07-23T12:34:09.364Z",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "[email protected]",
      "avatar": "https://example.com",
      "is_manual": true
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:34:09.364Z",
  "updated_at": "2025-07-23T12:34:09.364Z",
  "name": "text",
  "thumbnail": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

put

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this contact group.

Body

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

idstring · uuidRead-onlyRequired

user_idsstring · uuid[]Optional

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyRequired

namestring · max: 100Required

thumbnailstring · uri | nullableOptional

churchstring · uuidRequired

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

PUT /api/unified-communications/contact-groups/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 357

{
  "user_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "manual_contacts": [
    {
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "[email protected]"
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:34:09.364Z",
  "name": "text",
  "thumbnail": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "manual_contacts": [
    {
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "[email protected]"
    }
  ],
  "contacts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:34:09.364Z",
      "updated_at": "2025-07-23T12:34:09.364Z",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "[email protected]",
      "avatar": "https://example.com",
      "is_manual": true
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:34:09.364Z",
  "updated_at": "2025-07-23T12:34:09.364Z",
  "name": "text",
  "thumbnail": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

delete

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this contact group.

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

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

Body

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

idstring · uuidRead-onlyOptional

user_idsstring · uuid[]Optional

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyOptional

namestring · max: 100Optional

thumbnailstring · uri | nullableOptional

churchstring · uuidOptional

Responses

200Success

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/unified-communications/contact-groups/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 357

{
  "user_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "manual_contacts": [
    {
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "[email protected]"
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:34:09.364Z",
  "name": "text",
  "thumbnail": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "manual_contacts": [
    {
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "[email protected]"
    }
  ],
  "contacts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:34:09.364Z",
      "updated_at": "2025-07-23T12:34:09.364Z",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "[email protected]",
      "avatar": "https://example.com",
      "is_manual": true
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:34:09.364Z",
  "updated_at": "2025-07-23T12:34:09.364Z",
  "name": "text",
  "thumbnail": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}