Smart keyword

get

Authorizations

Query parameters

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/unified-communications/smart-keyword 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",
      "hit_count": "text",
      "hits": "text",
      "notify_users_display": [
        {
          "id": "text",
          "email": "text",
          "phone": "text",
          "profile": "text",
          "additional_user_fields": "text"
        }
      ],
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:20:04.180Z",
      "updated_at": "2025-07-23T12:20:04.180Z",
      "keyword": "text",
      "description": "text",
      "credits_deducted_per_hit": 1,
      "message_type": "sms",
      "status": "Active",
      "media_url": "https://example.com",
      "notify_users": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

post

Authorizations

Body

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

idstring · uuidRead-onlyRequired

hit_countstringRead-onlyRequired

hitsstringRead-onlyRequired

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyRequired

keywordstring · max: 50Required

The word or phrase that triggers this keyword.

descriptionstringOptional

The reply text for this keyword.

credits_deducted_per_hitinteger · max: 2147483647Optional

The number of credits deducted from the church for each hit.

message_typestring · enumOptional

• sms - SMS
• mms - MMS
• voice - Voice

Possible values:

statusstring · enumOptional

• Active - Active
• Inactive - Inactive

Possible values:

media_urlstring · uri | nullableOptional

notify_usersstring · uuid[]Optional

Users to be notified when this keyword is triggered.

Responses

201Success

application/json

post

HTTPcURLJavaScriptPython

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

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:20:04.180Z",
  "keyword": "text",
  "description": "text",
  "credits_deducted_per_hit": 1,
  "message_type": "sms",
  "status": "Active",
  "media_url": "https://example.com",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

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

201Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "hit_count": "text",
  "hits": "text",
  "notify_users_display": [
    {
      "id": "text",
      "email": "text",
      "phone": "text",
      "profile": "text",
      "additional_user_fields": "text"
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:20:04.180Z",
  "updated_at": "2025-07-23T12:20:04.180Z",
  "keyword": "text",
  "description": "text",
  "credits_deducted_per_hit": 1,
  "message_type": "sms",
  "status": "Active",
  "media_url": "https://example.com",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

get

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this smart keyword.

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "hit_count": "text",
  "hits": "text",
  "notify_users_display": [
    {
      "id": "text",
      "email": "text",
      "phone": "text",
      "profile": "text",
      "additional_user_fields": "text"
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:20:04.180Z",
  "updated_at": "2025-07-23T12:20:04.180Z",
  "keyword": "text",
  "description": "text",
  "credits_deducted_per_hit": 1,
  "message_type": "sms",
  "status": "Active",
  "media_url": "https://example.com",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

put

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this smart keyword.

Body

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

idstring · uuidRead-onlyRequired

hit_countstringRead-onlyRequired

hitsstringRead-onlyRequired

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyRequired

keywordstring · max: 50Required

The word or phrase that triggers this keyword.

descriptionstringOptional

The reply text for this keyword.

credits_deducted_per_hitinteger · max: 2147483647Optional

The number of credits deducted from the church for each hit.

message_typestring · enumOptional

• sms - SMS
• mms - MMS
• voice - Voice

Possible values:

statusstring · enumOptional

• Active - Active
• Inactive - Inactive

Possible values:

media_urlstring · uri | nullableOptional

notify_usersstring · uuid[]Optional

Users to be notified when this keyword is triggered.

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

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

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:20:04.180Z",
  "keyword": "text",
  "description": "text",
  "credits_deducted_per_hit": 1,
  "message_type": "sms",
  "status": "Active",
  "media_url": "https://example.com",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "hit_count": "text",
  "hits": "text",
  "notify_users_display": [
    {
      "id": "text",
      "email": "text",
      "phone": "text",
      "profile": "text",
      "additional_user_fields": "text"
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:20:04.180Z",
  "updated_at": "2025-07-23T12:20:04.180Z",
  "keyword": "text",
  "description": "text",
  "credits_deducted_per_hit": 1,
  "message_type": "sms",
  "status": "Active",
  "media_url": "https://example.com",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

delete

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this smart keyword.

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

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

Body

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

idstring · uuidRead-onlyOptional

hit_countstringRead-onlyOptional

hitsstringRead-onlyOptional

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyOptional

keywordstring · max: 50Optional

The word or phrase that triggers this keyword.

descriptionstringOptional

The reply text for this keyword.

credits_deducted_per_hitinteger · max: 2147483647Optional

The number of credits deducted from the church for each hit.

message_typestring · enumOptional

• sms - SMS
• mms - MMS
• voice - Voice

Possible values:

statusstring · enumOptional

• Active - Active
• Inactive - Inactive

Possible values:

media_urlstring · uri | nullableOptional

notify_usersstring · uuid[]Optional

Users to be notified when this keyword is triggered.

Responses

200Success

application/json

patch

HTTPcURLJavaScriptPython

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

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:20:04.180Z",
  "keyword": "text",
  "description": "text",
  "credits_deducted_per_hit": 1,
  "message_type": "sms",
  "status": "Active",
  "media_url": "https://example.com",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "hit_count": "text",
  "hits": "text",
  "notify_users_display": [
    {
      "id": "text",
      "email": "text",
      "phone": "text",
      "profile": "text",
      "additional_user_fields": "text"
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:20:04.180Z",
  "updated_at": "2025-07-23T12:20:04.180Z",
  "keyword": "text",
  "description": "text",
  "credits_deducted_per_hit": 1,
  "message_type": "sms",
  "status": "Active",
  "media_url": "https://example.com",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}