Smart keyword hit

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/smart-keyword-hit 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": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:14:26.908Z",
      "updated_at": "2025-07-23T12:14:26.908Z",
      "sender_phone": "text",
      "hit_at": "2025-07-23T12:14:26.908Z",
      "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}
post
Authorizations
Body
idstring · uuidRead-onlyRequired
userall ofRead-onlyRequired
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyRequired
sender_phonestring · max: 15Required

The phone number that triggered the keyword.

hit_atstring · date-timeRead-onlyRequired
smart_keywordstring · uuidRequired
Responses
201Success
application/json
post
POST /api/unified-communications/smart-keyword-hit HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:14:26.908Z",
  "sender_phone": "text",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}
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": "2025-07-23T12:14:26.908Z",
  "updated_at": "2025-07-23T12:14:26.908Z",
  "sender_phone": "text",
  "hit_at": "2025-07-23T12:14:26.908Z",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}
get
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this smart keyword hit.

Responses
200Success
application/json
get
GET /api/unified-communications/smart-keyword-hit/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
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": "2025-07-23T12:14:26.908Z",
  "updated_at": "2025-07-23T12:14:26.908Z",
  "sender_phone": "text",
  "hit_at": "2025-07-23T12:14:26.908Z",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}
put
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this smart keyword hit.

Body
idstring · uuidRead-onlyRequired
userall ofRead-onlyRequired
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyRequired
sender_phonestring · max: 15Required

The phone number that triggered the keyword.

hit_atstring · date-timeRead-onlyRequired
smart_keywordstring · uuidRequired
Responses
200Success
application/json
put
PUT /api/unified-communications/smart-keyword-hit/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:14:26.908Z",
  "sender_phone": "text",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}
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": "2025-07-23T12:14:26.908Z",
  "updated_at": "2025-07-23T12:14:26.908Z",
  "sender_phone": "text",
  "hit_at": "2025-07-23T12:14:26.908Z",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}
delete
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this smart keyword hit.

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

Body
idstring · uuidRead-onlyOptional
userall ofRead-onlyOptional
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyOptional
sender_phonestring · max: 15Optional

The phone number that triggered the keyword.

hit_atstring · date-timeRead-onlyOptional
smart_keywordstring · uuidOptional
Responses
200Success
application/json
patch
PATCH /api/unified-communications/smart-keyword-hit/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:14:26.908Z",
  "sender_phone": "text",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}
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": "2025-07-23T12:14:26.908Z",
  "updated_at": "2025-07-23T12:14:26.908Z",
  "sender_phone": "text",
  "hit_at": "2025-07-23T12:14:26.908Z",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}
PreviousWebhookNextVault