Chilkat Online Tools

VB6 / Zoho CRM REST APIs / Custom

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

' 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"
'     }
'   ]
' }

Dim json As New ChilkatJsonObject
success = json.UpdateString("share[0].user.id","{{user_id}}")
success = json.UpdateBool("share[0].share_related_records",1)
success = json.UpdateString("share[0].permission","full_access")
success = json.UpdateString("share[1].user.id","{{user_id}}")
success = json.UpdateBool("share[1].share_related_records",1)
success = json.UpdateString("share[1].permission","read_only")

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://domain.com/crm/v2/{{custom_module_api_name}}/{{record_id}}/actions/share","application/json",json)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Debug.Print resp.StatusCode
Debug.Print 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/{{custom_module_api_name}}/{{record_id}}/actions/share

Postman Collection Item JSON

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