ProTextingdevelopers
API REFERENCEv1

Reserve Keyword

POSThttps://api2.protexting.com/v1/keyword/reserve
⌘

Pass your server-side token as access_token. Replace sample values with your own. Authentication & setup →

Request parameters:

* required parameters

ParameterDescription
* KeywordString, min 4 characters
* NumberInteger, (account short code or long number) see here »
AutoreplyMessageString

Response parameters:

ParameterDescription
IdInt
KeywordString
NumberInteger,(account short code or long number) see here »
AutoreplyMessageString

Example Request:

Request example
# Set PROTEXTING_ACCESS_TOKEN in your environmentcurl --request POST \  "https://api2.protexting.com/v1/keyword/reserve?access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \  --header 'Accept: application/json'
Server-side exampleJSON · HTTPS

Example Response Headers:

Response headers example
Status Code: 201 OK
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Connection: Keep-Alive
Content-Type: application/xml; charset=utf-8
Keep-Alive: timeout=5, max=100
Link: <https://api2.protexting.com/v1/keyword/reserve?access_token=your_access_token>; rel=self Pragma: no-cache X-Powered-By: PHP/5.6.2 X-Rate-Limit-Limit: 60 X-Rate-Limit-Remaining: 59 X-Rate-Limit-Reset: 0

Example Response Body:

JSON response example
[
    {        "Id": 123,
    	"Keyword": "ProTexting",
        "Number": "82257",
        "AutoreplyMessage": "Thank you for joining. Reply HELP for help. Reply STOP to end."
    }
]
XML response example
<response>
    <item>        <Id>123</Id>         <Number>ProTexting</Number>
        <ShortCode>82257</ShortCode>        <AutoreplyMessage>Thank you for joining. Reply HELP for help. Reply STOP to end.</AutoreplyMessage>    </item>
</response>

HTTP Status Codes:

The standard HTTP Status Codes are used. More information is available here: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Error Codes:

Error Codes and Examples here »

← PreviousCheck Keyword AvailabilityNext →Remove Keyword

Reference from the ProTexting documentation catalog. Code examples are illustrative; this page does not execute API requests.