Chilkat Online Tools

phpExt / Zoho CRM REST APIs / Sales Orders

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.

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

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

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

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://domain.com/crm/v2/Sales_Orders/{{record_id}}/actions/share','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

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


?>

Curl Command

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

Postman Collection Item JSON

{
  "name": "Sales Orders",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"share\": [\n    {\n      \"user\": {\n        \"id\": \"{{user_id}}\"\n      },\n      \"share_related_records\": true,\n      \"permission\": \"full_access\"\n    },\n    {\n      \"user\": {\n        \"id\": \"{{user_id}}\"\n      },\n      \"share_related_records\": true,\n      \"permission\": \"read_only\"\n    }\n  ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/Sales_Orders/{{record_id}}/actions/share",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Sales_Orders",
        "{{record_id}}",
        "actions",
        "share"
      ]
    },
    "description": "To share a Sales Order with other users in the organization."
  },
  "response": [
  ]
}