Chilkat Online Tools

phpExt / Zoho CRM REST APIs / Deals

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "tags": [
//     {
//       "id": "{{tag_id}}",
//       "name": "Cold Deal"
//     },
//     {
//       "id": "{{tag_id}}",
//       "name": "Active Deal"
//     }
//   ]
// }

$json = new CkJsonObject();
$json->UpdateString('tags[0].id','{{tag_id}}');
$json->UpdateString('tags[0].name','Cold Deal');
$json->UpdateString('tags[1].id','{{tag_id}}');
$json->UpdateString('tags[1].name','Active Deal');

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);

// resp is a CkHttpResponse
$resp = $http->PTextSb('PUT','https://domain.com/crm/v2.1/settings/tags?module=Deals',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "tags": [
        {
            "id": "{{tag_id}}",
            "name": "Cold Deal"
        },
        {
            "id": "{{tag_id}}",
            "name": "Active Deal"
        }
    ]
}'
https://domain.com/crm/v2.1/settings/tags?module=Deals

Postman Collection Item JSON

{
  "name": "Deals",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"tags\": [\n        {\n            \"id\": \"{{tag_id}}\",\n            \"name\": \"Cold Deal\"\n        },\n        {\n            \"id\": \"{{tag_id}}\",\n            \"name\": \"Active Deal\"\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/settings/tags?module=Deals",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "settings",
        "tags"
      ],
      "query": [
        {
          "key": "module",
          "value": "Deals"
        }
      ]
    },
    "description": "To update tags."
  },
  "response": [
  ]
}