Keyword

The Keyword APIs allow you to manage keywords used for inbound messages.

Info

This page describes the API 3.2 routes. Use the Scalar API 3.2 reference for the generated request and response schemas.

Add

Adds a keyword. When detected at the beginning of an inbound message, the keyword is sent to your inbox for processing.

URL: base/Keyword
Method: POST

{
  "keyword": "sample string 1",
  "type": "normal",
  "response": "response message",
  "finishDate": "2026-12-31T23:59:59Z"
}

Parameters

Name	Description
Keyword	Keyword between 3 and 50 characters. Alphanumeric only.
Type	One of normal, stop, help, or info.
Response	For stop, help, or info keywords, the automatic response sent to the respondent.
FinishDate	The date the keyword expires. This should be in the future.

HTTP statuses

Status	Description
400	The keyword is already registered.
400	The keyword must be between 3 and 50 characters and alphanumeric only.
400	There was a problem registering the keyword. Contact DIY Surveys Support.

Update

Updates an existing keyword using the same model as Add.

URL: base/Keyword
Method: PATCH

{
  "keyword": "sample string 1",
  "type": "normal",
  "response": "updated response message",
  "finishDate": "2026-12-31T23:59:59Z"
}

Delete

Deletes a keyword.

URL: base/Keyword?keyword={keyword}
Method: DELETE

Parameters

Name	Description
keyword	The keyword to delete from your account.

HTTP statuses

Status	Description
404	The keyword is not found.
400	There was a problem deleting the keyword. Contact DIY Surveys Support.

List

Lists all keywords associated with your account.

URL: base/Keyword
Method: GET

Return example

[
  {
    "keyword": "keyword",
    "finishDate": "2026-12-31T23:59:59Z",
    "type": "normal",
    "response": "response message"
  }
]

HTTP statuses

Status	Description
400	There are no active keywords registered.