ProTextingdevelopers
API REFERENCEv1

Opt Out Contact

POSThttps://api2.protexting.com/v1/contacts/opt-out
⌘

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

Request parameters:

* required parameters

ParameterDescription
*PhoneNumber string, valid phone number

Error 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:

Status Code

(response header)

Description

(response header)

Field

(response body)

Message

(response body)

422 Data Validation Failed The attribute that didn't pass the validation The message, describing the validation error

Example Request:

Request example
# Set PROTEXTING_ACCESS_TOKEN in your environmentcurl --request POST \  "https://api2.protexting.com/v1/contacts/opt-out?access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \  --header 'Accept: application/json' \  --header 'Content-Type: application/json' \  --data '{  "PhoneNumber": "16461234567"}'
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": 1,
        "Number": "16461234567",
        "OptedOut": 1,
        "FirstName": "John",
        "LastName": "",
        "BirthDay": "0000-00-00",
        "Email": "",
        "Zip": "",
        "City": "",
        "DateCreated": "2015-01-20 10:21:29",
        "DateUpdated": "2015-01-20 10:41:29",
        "GroupIds":[1],
        "CustomFieldIds":[]
}

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 »

← PreviousOpt in Contact FlowNext →Undo Opt Out Contact

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