Chilkat Online Tools

PureBasic / Zoho CRM REST APIs / Price Books

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.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.

    ; {
    ;   "tags": [
    ;     {
    ;       "id": "{{tag_id}}",
    ;       "name": "Standard"
    ;     },
    ;     {
    ;       "id": "{{tag_id}}",
    ;       "name": "Supplier"
    ;     }
    ;   ]
    ; }

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

    CkJsonObject::ckUpdateString(json,"tags[0].id","{{tag_id}}")
    CkJsonObject::ckUpdateString(json,"tags[0].name","Standard")
    CkJsonObject::ckUpdateString(json,"tags[1].id","{{tag_id}}")
    CkJsonObject::ckUpdateString(json,"tags[1].name","Supplier")

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

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

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/crm/v2.1/settings/tags?module=Price_Books",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

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



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


    ProcedureReturn
EndProcedure

Curl Command

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

Postman Collection Item JSON

{
  "name": "Price Books",
  "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\": \"Standard\"\n        },\n        {\n            \"id\": \"{{tag_id}}\",\n            \"name\": \"Supplier\"\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/settings/tags?module=Price_Books",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "settings",
        "tags"
      ],
      "query": [
        {
          "key": "module",
          "value": "Price_Books"
        }
      ]
    },
    "description": "To update tags."
  },
  "response": [
  ]
}