API REFERENCEv1

Add Coupon Code

POSThttps://api2.protexting.com/v1/coupons/create

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

Request parameters:

* required parameters

ParameterDescription
* Couponstring, coupon code
InfoTextstring, custom info text to be added after the coupon code in the outgoing message. It will be added ONLY if there is value in the field. "InfoText" is added per coupon code, this way it can be different for each coupon code.
CouponCodeCustomTag_Idstring, coupon code custom tag id

Example Request:

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

Example Response Headers:

Response headers example
Status Code: 201 Created
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Connection: Keep-Alive
Content-Length: 243
Content-Type: application/json; charset=UTF-8
Keep-Alive: timeout=5, max=100
Pragma: no-cache
X-Powered-By: PHP/5.6.2
X-Rate-Limit-Limit: 60
X-Rate-Limit-Remaining: 59
X-Rate-Limit-Reset

Example Response Body:

JSON response example
{
        "Id": "7443bf12-0257-11eb-a4ae-f23c91cc2b28",
        "CouponCode": "discount10",        "InfoText": null,
        "SentTo": null,
        "ViaApp": "",
        "CreatedOn": "2020-09-29 09:27:00",
        "Status": "Not Sent",
        "CouponCodeCustomTag_Id": null,
        "SentOn": null
}
XML response example
<response>   <item>      <Id>7443bf12-0257-11eb-a4ae-f23c91cc2b28</Id>      <CouponCode>16461234567</CouponCode>      <InfoText/>      <SentTo/>      <ViaApp/>      <CreatedOn>2020-09-29 09:27:00</CreatedOn>      <Status>Not Sent</Status>      <CouponCodeCustomTag_Id/>      <SentOn />   </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 »

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