v1

latestOpenAPI 3.0.02026-07-244771176.5 KB

Keywords

Edit Keyword

Edit an existing keyword.

post/edit-keyword.json

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"
  }
}