Chilkat Online Tools

PureBasic / Zoho CRM REST APIs / Deals

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "data": [
    ;     {
    ;       "Stage": "Proposal/Price Quote"
    ;     }
    ;   ],
    ;   "over_write": true,
    ;   "ids": [
    ;     "{{record_id1}}",
    ;     "{{record_id2}}",
    ;     "{{record_id3}}"
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"data[0].Stage","Proposal/Price Quote")
    CkJsonObject::ckUpdateBool(json,"over_write",1)
    CkJsonObject::ckUpdateString(json,"ids[0]","{{record_id1}}")
    CkJsonObject::ckUpdateString(json,"ids[1]","{{record_id2}}")
    CkJsonObject::ckUpdateString(json,"ids[2]","{{record_id3}}")

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

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/crm/v2/Deals/actions/mass_update","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "data": [
        {
            "Stage": "Proposal/Price Quote"
        }
    ],
    "over_write": true,
     "ids": [
        "{{record_id1}}",
        "{{record_id2}}",
        "{{record_id3}}"
    ]
}'
https://domain.com/crm/v2/Deals/actions/mass_update

Postman Collection Item JSON

{
  "name": "Deals",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Stage\": \"Proposal/Price Quote\"\n        }\n    ],\n    \"over_write\": true,\n     \"ids\": [\n        \"{{record_id1}}\",\n        \"{{record_id2}}\",\n        \"{{record_id3}}\"\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/Deals/actions/mass_update",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Deals",
        "actions",
        "mass_update"
      ]
    },
    "description": "To schedule mass update for Deals"
  },
  "response": [
  ]
}