Chilkat Online Tools

Swift / Zoho CRM REST APIs / Cases

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

    let json = CkoJsonObject()
    json.UpdateString("share[0].user.id", value: "{{user_id}}")
    json.UpdateBool("share[0].share_related_records", value: true)
    json.UpdateString("share[0].permission", value: "full_access")
    json.UpdateString("share[1].user.id", value: "{{user_id}}")
    json.UpdateBool("share[1].share_related_records", value: true)
    json.UpdateString("share[1].permission", value: "read_only")

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

    var resp: CkoHttpResponse? = http.PostJson3("https://domain.com/crm/v2.1/Cases/{{record_id}}/actions/share", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

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.1/Cases/{{record_id}}/actions/share

Postman Collection Item JSON

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