KUkudosity
Keywords

Edit Keyword

Edit an existing keyword.

post/edit-keyword.json

Request

  • Base URL
    https://api.transmitsms.com
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

keywordstring required

The first word of a text message.

numberinteger required

The dedicated virtual number that the keyword belongs to.

referencestring

Your own reference (up to 100 characters).

status'Open' | 'Closed'

Open, will set the Keyword to being active. Closed, will close the Keyword.

list_idinteger

ID of a list to add respondents to. List ID's can be found in the title of a list or in the list page URL.

welcome_messagestring

SMS message to send to new members.

members_messagestring

SMS message to existing members.

activateboolean

Whether to make the keyword active immediately.

forward_urlstring uri

Forward messages to a URL.

forward_emailstring email

Forward messages to a set of email addresses.

forward_smsinteger[]

Forward messages to a set of msisdns.

Example request

{
  "keyword": "keyword",
  "number": 123456789,
  "reference": "reference",
  "list_id": 987654321,
  "welcome_message": "Welcome to our service!",
  "members_message": "Welcome back!",
  "forward_url": "http://example.com/forward",
  "forward_email": "example@example.com",
  "forward_sms": [
    123456789,
    987654321
  ]
}

Response

Successful response

keywordstring

The keyword.

referencestring

Your own reference.

numberinteger

The dedicated virtual number.

list_idinteger

ID of the list.

welcome_messagestring

SMS message to send to new members.

member_messagestring

SMS message to existing members.

forward_urlstring uri

Forward messages to a URL.

forward_smsstring

Forward messages to a set of MSISDNs.

forward_emailstring

Forward messages to a set of email addresses.

statusstring

Status of the response.

billing_datestring date

Date of billing.

Example response

{
  "keyword": "NEWS",
  "reference": "Gym news",
  "number": 61418279031,
  "list_id": 4214634,
  "welcome_message": "Welcome to Fitness gym news",
  "member_message": "Thanks for your continued support",
  "forward_url": "http://example.com/gym-promo",
  "forward_sms": "61491570157,61491570158",
  "forward_email": "news@example.com,mike@example.com",
  "status": "open",
  "billing_date": "2020-07-24",
  "error": {
    "code": "SUCCESS",
    "description": "OK"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.