Smart keyword hit

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/smart-keyword-hit

HTTPcURLJavaScriptPython

GET /api/unified-communications/smart-keyword-hit 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-17T04:11:20.691Z",
      "updated_at": "2026-02-17T04:11:20.691Z",
      "sender_phone": "text",
      "hit_at": "2026-02-17T04:11:20.691Z",
      "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

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

sender_phonestring · max: 15Required

The phone number that triggered the keyword.

hit_atstring · date-timeRead-onlyRequired

smart_keywordstring · uuidRequired

Responses

201Success

application/json

post

/api/unified-communications/smart-keyword-hit

HTTPcURLJavaScriptPython

POST /api/unified-communications/smart-keyword-hit HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T04:11:20.691Z",
  "sender_phone": "text",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}

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-17T04:11:20.691Z",
  "updated_at": "2026-02-17T04:11:20.691Z",
  "sender_phone": "text",
  "hit_at": "2026-02-17T04:11:20.691Z",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}

get

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this smart keyword hit.

Responses

200Success

application/json

get

/api/unified-communications/smart-keyword-hit/{id}

HTTPcURLJavaScriptPython

GET /api/unified-communications/smart-keyword-hit/{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-17T04:11:20.691Z",
  "updated_at": "2026-02-17T04:11:20.691Z",
  "sender_phone": "text",
  "hit_at": "2026-02-17T04:11:20.691Z",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}

put

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this smart keyword hit.

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

sender_phonestring · max: 15Required

The phone number that triggered the keyword.

hit_atstring · date-timeRead-onlyRequired

smart_keywordstring · uuidRequired

Responses

200Success

application/json

put

/api/unified-communications/smart-keyword-hit/{id}

HTTPcURLJavaScriptPython

PUT /api/unified-communications/smart-keyword-hit/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T04:11:20.691Z",
  "sender_phone": "text",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}

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-17T04:11:20.691Z",
  "updated_at": "2026-02-17T04:11:20.691Z",
  "sender_phone": "text",
  "hit_at": "2026-02-17T04:11:20.691Z",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}

delete

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this smart keyword hit.

Responses

204

No response body

delete

/api/unified-communications/smart-keyword-hit/{id}

HTTPcURLJavaScriptPython

DELETE /api/unified-communications/smart-keyword-hit/{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 smart keyword hit.

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

sender_phonestring · max: 15Optional

The phone number that triggered the keyword.

hit_atstring · date-timeRead-onlyOptional

smart_keywordstring · uuidOptional

Responses

200Success

application/json

patch

/api/unified-communications/smart-keyword-hit/{id}

HTTPcURLJavaScriptPython

PATCH /api/unified-communications/smart-keyword-hit/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T04:11:20.691Z",
  "sender_phone": "text",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}

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-17T04:11:20.691Z",
  "updated_at": "2026-02-17T04:11:20.691Z",
  "sender_phone": "text",
  "hit_at": "2026-02-17T04:11:20.691Z",
  "smart_keyword": "123e4567-e89b-12d3-a456-426614174000"
}