Chilkat Online Tools

phpAx / Zoho CRM REST APIs / Price Books

Back to Collection Items

<?php

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

$http = new COM("Chilkat_9_5_0.Http");

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

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

// {
//   "share": [
//     {
//       "user": {
//         "id": "{{user_id}}"
//       },
//       "share_related_records": true,
//       "permission": "read_only"
//     },
//     {
//       "user": {
//         "id": "{{user_id}}"
//       },
//       "share_related_records": false,
//       "permission": "full_access"
//     }
//   ]
// }

$json = new COM("Chilkat_9_5_0.JsonObject");
$json->UpdateString('share[0].user.id','{{user_id}}');
$json->UpdateBool('share[0].share_related_records',1);
$json->UpdateString('share[0].permission','read_only');
$json->UpdateString('share[1].user.id','{{user_id}}');
$json->UpdateBool('share[1].share_related_records',0);
$json->UpdateString('share[1].permission','full_access');

// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';

$sbRequestBody = new COM("Chilkat_9_5_0.StringBuilder");
$json->EmitSb($sbRequestBody);

// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->PTextSb('PUT','https://domain.com/crm/v2.1/Price_Books/{{record_id}}/actions/share',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "share": [
        {
            "user": {
                "id": "{{user_id}}"
            },
            "share_related_records": true,
            "permission": "read_only"
        },
        {
            "user": {
                "id": "{{user_id}}"
            },
            "share_related_records": false,
            "permission": "full_access"
        }
    ]
}'
https://domain.com/crm/v2.1/Price_Books/{{record_id}}/actions/share

Postman Collection Item JSON

{
  "name": "Price Books",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"share\": [\n        {\n            \"user\": {\n                \"id\": \"{{user_id}}\"\n            },\n            \"share_related_records\": true,\n            \"permission\": \"read_only\"\n        },\n        {\n            \"user\": {\n                \"id\": \"{{user_id}}\"\n            },\n            \"share_related_records\": false,\n            \"permission\": \"full_access\"\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/Price_Books/{{record_id}}/actions/share",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "Price_Books",
        "{{record_id}}",
        "actions",
        "share"
      ]
    },
    "description": "Update the sharing permissions of the shared record."
  },
  "response": [
  ]
}