Opt in Contact Flow

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:

1# Set PROTEXTING_ACCESS_TOKEN in your environment2curl --request POST \3  "https://api2.protexting.com/v1/contacts-opt-in/create?access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \4  --header 'Accept: application/json' \5  --header 'Content-Type: application/json' \6  --data '{7  "PhoneNumber": "16461234567",8  "GroupIds": [9    110  ]11}'

Example Response Headers:

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

Example Response Body:

1{
2        "message": "Confirmation message successfully sent",
3}

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