Smart keyword

get
Authorizations
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.

searchstringOptional

A search term.

Responses
chevron-right
200Success
application/json
get
/api/unified-communications/smart-keyword
200Success
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
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 · max: 200 · nullableOptional
notify_usersstring · uuid[]Optional

Users to be notified when this keyword is triggered.

Responses
post
/api/unified-communications/smart-keyword
201Success
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this smart keyword.

Responses
chevron-right
200Success
application/json
get
/api/unified-communications/smart-keyword/{id}
200Success
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this smart keyword.

Body
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 · max: 200 · nullableOptional
notify_usersstring · uuid[]Optional

Users to be notified when this keyword is triggered.

Responses
chevron-right
200Success
application/json
put
/api/unified-communications/smart-keyword/{id}
200Success
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this smart keyword.

Responses
delete
/api/unified-communications/smart-keyword/{id}
204

No response body

No content

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this smart keyword.

Body
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 · max: 200 · nullableOptional
notify_usersstring · uuid[]Optional

Users to be notified when this keyword is triggered.

Responses
chevron-right
200Success
application/json
patch
/api/unified-communications/smart-keyword/{id}
200Success