Opt In Contact Flow

URL:

https://api2.protexting.com/v1/contacts-opt-in/create?access_token=your_access_token

Method:

POST

Request parameters:

* required parameters

We send an automatic opt-in CTA message to the recipient with the following text: Reply with YES to confirm your phone number Msg&Data rates may apply. This confirmation SMS can be changed in the account dashboard.

Once the mobile number is confirmed with YES, the system will send out a confirmation text message: Your phone number is successfully confirmed

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

Example HTTP Status Code:

Example Request:

curl -i -H "Accept:application/json" -H "Content-Type:application/json" -XPOST "https://api2.protexting.com/v1/contacts-opt-in/create?access_token=your_access_token" -d '{"PhoneNumber":"16461234567","GroupIds":[1]}'

Example Response Headers:

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:

{
        "message": "Confirmation message successfully sent",
}

<response>
   <message>Confirmation message successfully sent</message>
</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 »