API REFERENCEv1
Update Group
PUT
https://api2.protexting.com/v1/groups/update⌘
Pass your server-side token as access_token. Replace sample values with your own. Authentication & setup →
Request parameters:
* required parameters
| Parameter | Description |
|---|---|
| * id (type: GET) | int |
| * fname | string, characters count between 3 and 255 symbols |
| fnote | string, characters count between 3 and 255 symbols |
Example Request:
Request example
# Set PROTEXTING_ACCESS_TOKEN in your environmentcurl --request PUT \ "https://api2.protexting.com/v1/groups/update?id=1&access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "fname": "my updated group", "fnote": "my updated informative note here"}'Example Response Headers:
Response headers example
Status Code: 200 OK Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0 Connection: Keep-Alive Content-Length: 211 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-ResetExample Response Body:
JSON response example
{
"Id": 1,
"Name": "my updated group",
"Note": "my updated informative note here",
"KeywordId": 0,
"ParentId": 0,
"DateCreated": "2015-01-20 10:21:29",
"DateUpdated": "2015-01-20 10:41:29",
"PhoneNumberIds": []
}XML response example
<response> <item> <Id>1</Id> <Name>my updated group</Name> <Note>my updated informative note here</Note> <KeywordId>0</KeywordId> <ParentId>0</ParentId> <DateCreated>2015-01-20 10:21:29</DateCreated> <DateUpdated>2015-01-20 10:41:29</DateUpdated> <PhoneNumberIds /> </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.