Chilkat Online Tools

Powershell / Zoho CRM REST APIs / Leads

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.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": "full_access"
#     },
#     {
#       "user": {
#         "id": "{{user_id}}"
#       },
#       "share_related_records": true,
#       "permission": "read_only"
#     }
#   ]
# }

$json = New-Object Chilkat.JsonObject
$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.AuthToken = "<access_token>"

$resp = $http.PostJson3("https://domain.com/crm/v2/Leads/{{record_id}}/actions/share","application/json",$json)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$($resp.StatusCode)
$($resp.BodyStr)

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/Leads/{{record_id}}/actions/share

Postman Collection Item JSON

{
  "name": "Leads",
  "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/Leads/{{record_id}}/actions/share",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Leads",
        "{{record_id}}",
        "actions",
        "share"
      ]
    },
    "description": "To share a Lead with other users in the organization."
  },
  "response": [
  ]
}