Chilkat Online Tools

PureBasic / Zoho CRM REST APIs / Campaigns

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": [
    ;     {
    ;       "Campaign_Name": "Sample",
    ;       "End_Date": "2021-01-31",
    ;       "Expected_Revenue": 5000,
    ;       "Start_Date": "2021-01-29",
    ;       "$approved": true,
    ;       "Status": "Planning",
    ;       "Type": "Conference",
    ;       "Budgeted_Cost": 2500
    ;     }
    ;   ]
    ; }

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

    CkJsonObject::ckUpdateString(json,"data[0].Campaign_Name","Sample")
    CkJsonObject::ckUpdateString(json,"data[0].End_Date","2021-01-31")
    CkJsonObject::ckUpdateInt(json,"data[0].Expected_Revenue",5000)
    CkJsonObject::ckUpdateString(json,"data[0].Start_Date","2021-01-29")
    CkJsonObject::ckUpdateBool(json,"data[0].$approved",1)
    CkJsonObject::ckUpdateString(json,"data[0].Status","Planning")
    CkJsonObject::ckUpdateString(json,"data[0].Type","Conference")
    CkJsonObject::ckUpdateInt(json,"data[0].Budgeted_Cost",2500)

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

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

    success = CkHttp::ckHttpJson(http,"POST","https://domain.com/crm/v2.1/Campaigns/upsert",json,"application/json",resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

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


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


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "data": [
        {
            "Campaign_Name": "Sample",
            "End_Date": "2021-01-31",
            "Expected_Revenue": 5000,
            "Start_Date": "2021-01-29",
            "$approved": true,
            "Status": "Planning",
            "Type": "Conference",
            "Budgeted_Cost": 2500
        }
    ]
}'
https://domain.com/crm/v2.1/Campaigns/upsert

Postman Collection Item JSON

{
  "name": "Campaigns",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Campaign_Name\": \"Sample\",\n            \"End_Date\": \"2021-01-31\",\n            \"Expected_Revenue\": 5000,\n            \"Start_Date\": \"2021-01-29\",\n            \"$approved\": true,\n            \"Status\": \"Planning\",\n            \"Type\": \"Conference\",\n            \"Budgeted_Cost\": 2500\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/Campaigns/upsert",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "Campaigns",
        "upsert"
      ]
    },
    "description": "To upsert records in the Campaigns module."
  },
  "response": [
  ]
}