Chilkat Online Tools

C / Zoho CRM REST APIs / Custom

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkHttpResponse resp;

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

    http = CkHttp_Create();

    // 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 = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"share[0].user.id","{{user_id}}");
    CkJsonObject_UpdateBool(json,"share[0].share_related_records",TRUE);
    CkJsonObject_UpdateString(json,"share[0].permission","full_access");
    CkJsonObject_UpdateString(json,"share[1].user.id","{{user_id}}");
    CkJsonObject_UpdateBool(json,"share[1].share_related_records",TRUE);
    CkJsonObject_UpdateString(json,"share[1].permission","read_only");

    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttp_putAuthToken(http,"<access_token>");

    resp = CkHttp_PostJson3(http,"https://domain.com/crm/v2/{{custom_module_api_name}}/{{record_id}}/actions/share","application/json",json);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        return;
    }

    printf("%d\n",CkHttpResponse_getStatusCode(resp));
    printf("%s\n",CkHttpResponse_bodyStr(resp));
    CkHttpResponse_Dispose(resp);


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);

    }

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": [
  ]
}