Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCode
LOCAL lcId
LOCAL lcMessage
LOCAL lcStatus
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* Use this online tool to generate code from sample JSON: Generate Code to Create JSON
* The following JSON is sent in the request body.
* {
* "variables": [
* {
* "name": "Variable100",
* "api_name": "Variable100",
* "variable_group": {
* "id": "{{variable_group_id}}"
* },
* "type": "integer",
* "value": 33,
* "description": "This denotes variable 3 description"
* },
* {
* "name": "Variable101",
* "api_name": "Variable101",
* "variable_group": {
* "name": "General"
* },
* "type": "text",
* "value": "Hello",
* "description": "This denotes variable 4 description"
* }
* ]
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("variables[0].name","Variable100")
loJson.UpdateString("variables[0].api_name","Variable100")
loJson.UpdateString("variables[0].variable_group.id","{{variable_group_id}}")
loJson.UpdateString("variables[0].type","integer")
loJson.UpdateInt("variables[0].value",33)
loJson.UpdateString("variables[0].description","This denotes variable 3 description")
loJson.UpdateString("variables[1].name","Variable101")
loJson.UpdateString("variables[1].api_name","Variable101")
loJson.UpdateString("variables[1].variable_group.name","General")
loJson.UpdateString("variables[1].type","text")
loJson.UpdateString("variables[1].value","Hello")
loJson.UpdateString("variables[1].description","This denotes variable 4 description")
loHttp.SetRequestHeader("Authorization","{{authorization-token}}")
loResp = loHttp.PostJson3("https://domain.com/crm/v2.1/settings/variables","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "variables": [
* {
* "code": "SUCCESS",
* "details": {
* "id": "738964000002130239"
* },
* "message": "variable added",
* "status": "success"
* },
* {
* "code": "SUCCESS",
* "details": {
* "id": "738964000002130241"
* },
* "message": "variable added",
* "status": "success"
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i = 0
lnCount_i = loJResp.SizeOfArray("variables")
DO WHILE i < lnCount_i
loJResp.I = i
lcCode = loJResp.StringOf("variables[i].code")
lcId = loJResp.StringOf("variables[i].details.id")
lcMessage = loJResp.StringOf("variables[i].message")
lcStatus = loJResp.StringOf("variables[i].status")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Authorization: {{authorization-token}}"
-d '{
"variables": [
{
"name": "Variable100",
"api_name": "Variable100",
"variable_group": {
"id": "{{variable_group_id}}"
},
"type": "integer",
"value": 33,
"description": "This denotes variable 3 description"
},
{
"name": "Variable101",
"api_name": "Variable101",
"variable_group": {
"name": "General"
},
"type": "text",
"value": "Hello",
"description": "This denotes variable 4 description"
}
]
}'
https://domain.com/crm/v2.1/settings/variables
Postman Collection Item JSON
{
"name": "Create Variables",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"variables\": [\n {\n \"name\": \"Variable100\",\n \"api_name\": \"Variable100\",\n \"variable_group\": {\n \"id\": \"{{variable_group_id}}\"\n },\n \"type\": \"integer\",\n \"value\": 33,\n \"description\": \"This denotes variable 3 description\"\n },\n {\n \"name\": \"Variable101\",\n \"api_name\": \"Variable101\",\n \"variable_group\": {\n \"name\": \"General\"\n },\n \"type\": \"text\",\n \"value\": \"Hello\",\n \"description\": \"This denotes variable 4 description\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/variables",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"variables"
]
},
"description": "To create a new variable in CRM."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"variables\": [\n {\n \"name\": \"Test1\",\n \"api_name\": \"Test1\",\n \"variable_group\": {\n \"id\": \"738964000002058078\"\n },\n \"type\": \"integer\",\n \"value\": 33,\n \"description\": \"This denotes variable 3 description\"\n },\n {\n \"name\": \"Test2\",\n \"api_name\": \"Test2\",\n \"variable_group\": {\n \"name\": \"General\"\n },\n \"type\": \"text\",\n \"value\": \"Hello\",\n \"description\": \"This denotes variable 4 description\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/variables",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"variables"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 11:28:48 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "221"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-07T12:00:40+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"variables\": [\n {\n \"code\": \"SUCCESS\",\n \"details\": {\n \"id\": \"738964000002130239\"\n },\n \"message\": \"variable added\",\n \"status\": \"success\"\n },\n {\n \"code\": \"SUCCESS\",\n \"details\": {\n \"id\": \"738964000002130241\"\n },\n \"message\": \"variable added\",\n \"status\": \"success\"\n }\n ]\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"variables\": [\n {\n \"name\": \"Test1\",\n \"api_name\": \"Test1\",\n \"variable_group\": {\n \"id\": \"738964000002058078\"\n },\n \"type\": \"integer\",\n \"value\": 33,\n \"description\": \"This denotes variable 3 description\"\n },\n {\n \"name\": \"Test2\",\n \"api_name\": \"Test2\",\n \"variable_group\": {\n \"name\": \"General\"\n },\n \"type\": \"text\",\n \"value\": \"Hello\",\n \"description\": \"This denotes variable 4 description\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/variables",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"variables"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 11:29:34 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "124"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Frame-Options",
"value": "deny"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_REQUEST_METHOD\",\n \"details\": {},\n \"message\": \"The http request method type is not a valid one\",\n \"status\": \"error\"\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"variables\": [\n {\n \"name\": \"Test1\",\n \"api_name\": \"Test1\",\n \"variable_group\": {\n \"id\": \"738964000002058078\"\n },\n \"type\": \"integer\",\n \"value\": 33,\n \"description\": \"This denotes variable 3 description\"\n },\n {\n \"name\": \"Test2\",\n \"api_name\": \"Test2\",\n \"variable_group\": {\n \"name\": \"General\"\n },\n \"type\": \"text\",\n \"value\": \"Hello\",\n \"description\": \"This denotes variable 4 description\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/variables",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"variables"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 11:29:52 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "98"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"AUTHENTICATION_FAILURE\",\n \"details\": {},\n \"message\": \"Authentication failed\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_DATA",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"variables\": [\n {\n \"name\": \"Test3\",\n \"api_name\": \"Test3\",\n \"variable_group\": {\n \"id\": \"738964000002058078\"\n },\n \"type\": \"integer\",\n \"value\": \"test\",\n \"description\": \"This denotes variable 3 description\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/variables",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"variables"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 11:30:35 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "178"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-07T12:00:40+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"variables\": [\n {\n \"code\": \"INVALID_DATA\",\n \"details\": {\n \"expected_data_type\": \"integer\",\n \"api_name\": \"value\",\n \"json_path\": \"$.variables[0].value\"\n },\n \"message\": \"invalid data\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "PATTERN_NOT_MATCHED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"variables\": [\n {\n \"name\": \"Test3\",\n \"api_name\": \"Test3\",\n \"variable_group\": {\n \"id\": test\n },\n \"type\": \"integer\",\n \"value\": 100,\n \"description\": \"This denotes variable 3 description\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/variables",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"variables"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 11:31:16 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "138"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"PATTERN_NOT_MATCHED\",\n \"details\": {\n \"api_name\": \"id\"\n },\n \"message\": \"Please check whether the input values are correct\",\n \"status\": \"error\"\n}"
},
{
"name": "DUPLICATE_DATA",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"variables\": [\n {\n \"name\": \"Test3\",\n \"api_name\": \"Test3\",\n \"variable_group\": {\n \"id\": \"738964000002058078\"\n },\n \"type\": \"integer\",\n \"value\": 100,\n \"description\": \"This denotes variable 3 description\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/variables",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"variables"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 11:31:42 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "149"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-07T12:00:40+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"variables\": [\n {\n \"code\": \"DUPLICATE_DATA\",\n \"details\": {\n \"api_name\": \"name\",\n \"json_path\": \"$.variables[0].name\"\n },\n \"message\": \"duplicate data\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "REQUIRED_PARAM_MISSING",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"variables\": [\n {\n \"name\": \"Test4\",\n \"api_name\": \"Test4\",\n \"type\": \"integer\",\n \"value\": 100,\n \"description\": \"This denotes variable 3 description\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/variables",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"variables"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 11:32:23 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "144"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"REQUIRED_PARAM_MISSING\",\n \"details\": {\n \"api_name\": \"variable_group\"\n },\n \"message\": \"One of the expected parameter is missing\",\n \"status\": \"error\"\n}"
},
{
"name": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"variables\": [\n {\n \"name\": \"Variable100\",\n \"api_name\": \"Variable100\",\n \"variable_group\": {\n \"id\": \"{{variable_group_id}}\"\n },\n \"type\": \"integer\",\n \"value\": 33,\n \"description\": \"This denotes variable 3 description\"\n },\n {\n \"name\": \"Variable101\",\n \"api_name\": \"Variable101\",\n \"variable_group\": {\n \"name\": \"General\"\n },\n \"type\": \"text\",\n \"value\": \"Hello\",\n \"description\": \"This denotes variable 4 description\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/variables",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"variables"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 08:37:12 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "113"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"OAUTH_SCOPE_MISMATCH\",\n \"details\": {},\n \"message\": \"invalid oauth scope to access this URL\",\n \"status\": \"error\"\n}"
}
]
}
