Method: DeleteKeyword

Method Type: Post

This method will be called by your application to remove a secondary or responder keyword from the store and release it to the spare pool for other CRM Text SMS API Clients to use. It cannot be used to remove the primary store keyword.

  Restrictions


  • The store‚Äôs primary keyword cannot be deleted using this method.
  • You will not be able to edit the content of an opt-in keyword for compliance reasons. If you wish to manage your own opt-in keyword responses, you can do by contacting support.
  • A keyword only consisting of numbers and any keyword containing spaces are not allowed but can be requested on a custom basis by emailing us at support.
  • Keywords must also be 4-19 characters long. Shorter keywords are also available on a case reviewed basis. Email us at support if you would like a 3 character or less keyword.
  • Keywords must also be 4-19 characters long. Shorter keywords are also available on a case reviewed basis. Email us at supportif you would like a 3 character or less keyword.

  Suggestions


  • If you delete a keyword and want to reuse it again, you can add it back if available. Opt-ins associated with the deleted keyword will not be affected and the subscriber status will not be changed.

Request Example

Delete a secondary opt-in or responder (TextCode) keyword
https://restapi.crmtext.com/smapi/rest?method=deletekeyword&keyword=&autoresponder=


Request Parameters

Name Required Value Description
keyword Yes String The keyword you wish to delete
autoresponder Yes integer A value of "0" for an opt-in keyword
A value of "1" for an responder keyword

XML Sample Successful Response

1
2
3
4
<response op= "optoutcustomer" status= "200" message= "ok">
<deleted>1</deleted>
<keyword>KEYWORD</keyword>
</response>

XML Sample Error Response

1
2
<response op= "optoutcustomer" status= "4xx" message= "reason for Error">
</response>