API REFERENCEv1

Add Contact

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

⌘

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

Request parameters:

* required parameters

Parameter	Description
* fnumber	string, valid phone number
ffirstname	string, max 100 symbols
flastname	string, max 100 symbols
fbirthdate	date
femail	string, max 64 symbols, validation against email format
fzipcode	string
fcity	string
* GroupIds	Array of group Ids
Message	string, max 148 symbols, validation against forbidden words (https://www.protexting.com/developers/docs/forbidden-words-phrases)
frfield	int, Custom Field Id
fvalue	string, max 255, Custom Field Value

Example Request:

Request example

1# Set PROTEXTING_ACCESS_TOKEN in your environment2curl --request POST \3  "https://api2.protexting.com/v1/contacts/create?access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \4  --header 'Accept: application/json' \5  --header 'Content-Type: application/json' \6  --data '{7  "fnumber": "16461234567",8  "ffirstname": "John",9  "GroupIds": [10    111  ],12  "Message": "Welcome to our text messaging list. You will be receiving up to 2 SMS with updates/month",13  "frfield": 1,14  "fvalue": "[email protected]"15}'

Server-side exampleJSON · HTTPS

Example Response Headers:

Response headers example

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:

JSON response example

1{
2        "Id": 1,
3        "Number": "16461234567",
4        "OptedOut": 0,
5        "FirstName": "John",
6        "LastName": "",
7        "BirthDay": "0000-00-00",
8        "Email": "",
9        "Zip": "",
10        "City": "",
11        "DateCreated": "2015-01-20 10:21:29",
12        "DateUpdated": "2015-01-20 10:41:29",
13        "GroupIds":[1],
14        "CustomFieldIds":[]
15}

XML response example

1<response>2   <item>3      <Id>1</Id>4      <Number>16461234567</Number>5      <OptedOut>0</OptedOut>6      <FirstName>John</FirstName>7      <LastName />8      <BirthDay>0000-00-00</BirthDay>9      <Email />10      <Zip />11      <City />12      <DateCreated>2015-01-20 10:21:29</DateCreated>13      <DateUpdated>2015-01-20 10:41:29</DateUpdated>14      <GroupIds>15         <item>1</item>16      </GroupIds>17      <CustomFieldIds />18   </item>19</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 »

← PreviousView Contact Next →Update Contact

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