Chilkat Online Tools

autoit / Zoho CRM REST APIs / Campaigns

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

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

; The following JSON is sent in the request body.

; {
;   "tags": [
;     {
;       "id": "{{tag_id}}",
;       "name": "Seasonal"
;     },
;     {
;       "id": "{{tag_id}}",
;       "name": "Traditional"
;     }
;   ]
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("tags[0].id","{{tag_id}}")
$oJson.UpdateString("tags[0].name","Seasonal")
$oJson.UpdateString("tags[1].id","{{tag_id}}")
$oJson.UpdateString("tags[1].name","Traditional")

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PUT","https://domain.com/crm/v2/settings/tags?module=Campaigns",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "tags": [
        {
            "id": "{{tag_id}}",
            "name": "Seasonal"
        },
        {
            "id": "{{tag_id}}",
            "name": "Traditional"
        }
    ]
}'
https://domain.com/crm/v2/settings/tags?module=Campaigns

Postman Collection Item JSON

{
  "name": "Campaigns",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"tags\": [\n        {\n            \"id\": \"{{tag_id}}\",\n            \"name\": \"Seasonal\"\n        },\n        {\n            \"id\": \"{{tag_id}}\",\n            \"name\": \"Traditional\"\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/settings/tags?module=Campaigns",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "settings",
        "tags"
      ],
      "query": [
        {
          "key": "module",
          "value": "Campaigns"
        }
      ]
    },
    "description": "To update tags."
  },
  "response": [
  ]
}