Chilkat Online Tools

Delphi (DLL) / Zoho CRM REST APIs / Insert Subforms

Back to Collection Items

var

begin
CkJsonObject_UpdateString(json,'data[0].Last_Name','Contact_test');CkJsonObject_UpdateString(json,'data[0].Email','contact_test@xyz.com');CkJsonObject_UpdateString(json,'data[0].Languages[0].Proficiency','Native');CkJsonObject_UpdateString(json,'data[0].Languages[0].Languages_Known','English');CkJsonObject_UpdateString(json,'data[0].Languages[1].Proficiency','Professional');CkJsonObject_UpdateString(json,'data[0].Languages[1].Languages_Known','French');CkJsonObject_UpdateBool(json,'data[0].Availability[0].Weekends',False);CkJsonObject_UpdateBool(json,'data[0].Availability[0].Weekdays',True);CkHttp_putAuthToken(http,'<access_token>');success := CkHttp_HttpJson(http,'POST','https://domain.com/crm/v2/Leads',json,'application/json',resp);CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);code := CkJsonObject__stringOf(jResp,'data[i].code');Modified_Time := CkJsonObject__stringOf(jResp,'data[i].details.Modified_Time');Name := CkJsonObject__stringOf(jResp,'data[i].details.Modified_By.name');Id := CkJsonObject__stringOf(jResp,'data[i].details.Modified_By.id');Created_Time := CkJsonObject__stringOf(jResp,'data[i].details.Created_Time');detailsId := CkJsonObject__stringOf(jResp,'data[i].details.id');Created_ByName := CkJsonObject__stringOf(jResp,'data[i].details.Created_By.name');Created_ById := CkJsonObject__stringOf(jResp,'data[i].details.Created_By.id');message := CkJsonObject__stringOf(jResp,'data[i].message');status := CkJsonObject__stringOf(jResp,'data[i].status');i := i + 1;


Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "data": [
        {
            "Last_Name": "Contact_test",
            "Email": "contact_test@xyz.com",
            "Languages": [
                {
                    "Proficiency": "Native",
                    "Languages_Known": "English"
                },
                {
                    "Proficiency": "Professional",
                    "Languages_Known": "French"
                }
            ],
            "Availability": [
                {
                    "Weekends": false,
                    "Weekdays": true
                }
            ]
        }
    ]
}'
https://domain.com/crm/v2/Leads

Postman Collection Item JSON

{
  "name": "Insert Subforms",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Last_Name\": \"Contact_test\",\n            \"Email\": \"contact_test@xyz.com\",\n            \"Languages\": [\n                {\n                    \"Proficiency\": \"Native\",\n                    \"Languages_Known\": \"English\"\n                },\n                {\n                    \"Proficiency\": \"Professional\",\n                    \"Languages_Known\": \"French\"\n                }\n            ],\n            \"Availability\": [\n                {\n                    \"Weekends\": false,\n                    \"Weekdays\": true\n                }\n            ]\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/Leads",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Leads"
      ]
    },
    "description": "To insert a new record with subforms in a module."
  },
  "response": [
    {
      "name": "SUCCESS RESPONSE",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"data\": [\n        {\n            \"Last_Name\": \"Contact_test\",\n            \"Email\": \"contact_test@xyz.com\",\n            \"Languages\": [\n                {\n                    \"Proficiency\": \"Native\",\n                    \"Languages_Known\": \"English\"\n                },\n                {\n                    \"Proficiency\": \"Professional\",\n                    \"Languages_Known\": \"French\"\n                }\n            ],\n            \"Availability\": [\n                {\n                    \"Weekends\": false,\n                    \"Weekdays\": true\n                }\n            ]\n        }\n    ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{api-domain}}/crm/v2/Leads",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "Leads"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Tue, 11 May 2021 13:17:49 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "329"
        },
        {
          "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-store, no-cache, must-revalidate, private"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-ACCESSTOKEN-RESET",
          "value": "2021-05-11T13:58:39+00:00"
        },
        {
          "key": "clientVersion",
          "value": "4023320"
        },
        {
          "key": "clientsubVersion",
          "value": "4d8b6ee4f7d1d284c930a4e807480c5c"
        },
        {
          "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    \"data\": [\n        {\n            \"code\": \"SUCCESS\",\n            \"details\": {\n                \"Modified_Time\": \"2021-05-11T13:17:55+00:00\",\n                \"Modified_By\": {\n                    \"name\": \"Patricia Boyle\",\n                    \"id\": \"738964000000291009\"\n                },\n                \"Created_Time\": \"2021-05-11T13:17:55+00:00\",\n                \"id\": \"738964000002148258\",\n                \"Created_By\": {\n                    \"name\": \"Patricia Boyle\",\n                    \"id\": \"738964000000291009\"\n                }\n            },\n            \"message\": \"record added\",\n            \"status\": \"success\"\n        }\n    ]\n}"
    },
    {
      "name": "INVALID_MODULE",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"data\": [\n        {\n            \"Last_Name\": \"Contact_test\",\n            \"Email\": \"contact_test@xyz.com\",\n            \"Languages\": [\n                {\n                    \"Proficiency\": \"Native\",\n                    \"Languages_Known\": \"English\"\n                },\n                {\n                    \"Proficiency\": \"Professional\",\n                    \"Languages_Known\": \"French\"\n                }\n            ],\n            \"Availability\": [\n                {\n                    \"Weekends\": false,\n                    \"Weekdays\": true\n                }\n            ]\n        }\n    ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{api-domain}}/crm/v2/Lead",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "Lead"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Tue, 11 May 2021 13:18:53 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "110"
        },
        {
          "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-store, no-cache, must-revalidate, private"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-ACCESSTOKEN-RESET",
          "value": "2021-05-11T13:58:39+00:00"
        },
        {
          "key": "clientVersion",
          "value": "4023320"
        },
        {
          "key": "clientsubVersion",
          "value": "4d8b6ee4f7d1d284c930a4e807480c5c"
        },
        {
          "key": "Content-Disposition",
          "value": "attachment; filename=response.json"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        },
        {
          "key": "Content-Language",
          "value": "en-US"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"INVALID_MODULE\",\n    \"details\": {},\n    \"message\": \"the module name given seems to be invalid\",\n    \"status\": \"error\"\n}"
    },
    {
      "name": "INVALID_REQUEST_METHOD",
      "originalRequest": {
        "method": "COPY",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"data\": [\n        {\n            \"Last_Name\": \"Contact_test\",\n            \"Email\": \"contact_test@xyz.com\",\n            \"Languages\": [\n                {\n                    \"Proficiency\": \"Native\",\n                    \"Languages_Known\": \"English\"\n                },\n                {\n                    \"Proficiency\": \"Professional\",\n                    \"Languages_Known\": \"French\"\n                }\n            ],\n            \"Availability\": [\n                {\n                    \"Weekends\": false,\n                    \"Weekdays\": true\n                }\n            ]\n        }\n    ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{api-domain}}/crm/v2/Lead",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "Lead"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Tue, 11 May 2021 13:19:07 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": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"data\": [\n        {\n            \"Last_Name\": \"Contact_test\",\n            \"Email\": \"contact_test@xyz.com\",\n            \"Languages\": [\n                {\n                    \"Proficiency\": \"Native\",\n                    \"Languages_Known\": \"English\"\n                },\n                {\n                    \"Proficiency\": \"Professional\",\n                    \"Languages_Known\": \"French\"\n                }\n            ],\n            \"Availability\": [\n                {\n                    \"Weekends\": false,\n                    \"Weekdays\": true\n                }\n            ]\n        }\n    ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{api-domain}}/crm/v2/Lead",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "Lead"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Tue, 11 May 2021 13:19:33 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": "MANDATORY_NOT_FOUND",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"data\": [\n        {\n            \"Email\": \"contact_test@xyz.com\",\n            \"Languages\": [\n                {\n                    \"Proficiency\": \"Native\",\n                    \"Languages_Known\": \"English\"\n                },\n                {\n                    \"Proficiency\": \"Professional\",\n                    \"Languages_Known\": \"French\"\n                }\n            ],\n            \"Availability\": [\n                {\n                    \"Weekends\": false,\n                    \"Weekdays\": true\n                }\n            ]\n        }\n    ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{api-domain}}/crm/v2/Leads",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "Leads"
          ]
        }
      },
      "status": "Accepted",
      "code": 202,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Tue, 11 May 2021 13:19:59 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "130"
        },
        {
          "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-store, no-cache, must-revalidate, private"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-ACCESSTOKEN-RESET",
          "value": "2021-05-11T13:58:39+00:00"
        },
        {
          "key": "clientVersion",
          "value": "4023320"
        },
        {
          "key": "clientsubVersion",
          "value": "4d8b6ee4f7d1d284c930a4e807480c5c"
        },
        {
          "key": "Content-Disposition",
          "value": "attachment; filename=response.json"
        },
        {
          "key": "Content-Language",
          "value": "en-US"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"data\": [\n        {\n            \"code\": \"MANDATORY_NOT_FOUND\",\n            \"details\": {\n                \"api_name\": \"Last_Name\"\n            },\n            \"message\": \"required field not found\",\n            \"status\": \"error\"\n        }\n    ]\n}"
    },
    {
      "name": "OAUTH_SCOPE_MISMATCH",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"data\": [\n        {\n            \"Last_Name\": \"Contact_test\",\n            \"Email\": \"contact_test@xyz.com\",\n            \"Languages\": [\n                {\n                    \"Proficiency\": \"Native\",\n                    \"Languages_Known\": \"English\"\n                },\n                {\n                    \"Proficiency\": \"Professional\",\n                    \"Languages_Known\": \"French\"\n                }\n            ],\n            \"Availability\": [\n                {\n                    \"Weekends\": false,\n                    \"Weekdays\": true\n                }\n            ]\n        }\n    ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{api-domain}}/crm/v2/Leads",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2",
            "Leads"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Thu, 13 May 2021 06:35:57 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}"
    }
  ]
}