Chilkat Online Tools

SQL Server / Zoho CRM REST APIs / Cases

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    -- 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": [
    --     {
    --       "Email": "patricia.boyle1@zylker.com",
    --       "Description": "This is a sample case",
    --       "Deal_Name": {
    --         "name": "Sample",
    --         "id": "{{deal_id}}"
    --       },
    --       "Phone": "9090909090",
    --       "Account_Name": {
    --         "name": "Sample",
    --         "id": "{{account_id}}"
    --       },
    --       "Solution": "This is a sample solution",
    --       "Status": "New",
    --       "Priority": "Medium",
    --       "Product_Name": {
    --         "name": "Sample Product",
    --         "id": "{{product_name}}"
    --       },
    --       "Case_Origin": "Email",
    --       "Subject": "This is a sample Case",
    --       "Case_Reason": "User did not attend any training.",
    --       "Related_To": {
    --         "name": "Patricia Boyle",
    --         "id": "{{contact_id}}"
    --       }
    --     }
    --   ]
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Email', 'patricia.boyle1@zylker.com'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Description', 'This is a sample case'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Deal_Name.name', 'Sample'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Deal_Name.id', '{{deal_id}}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Phone', '9090909090'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Account_Name.name', 'Sample'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Account_Name.id', '{{account_id}}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Solution', 'This is a sample solution'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Status', 'New'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Priority', 'Medium'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Product_Name.name', 'Sample Product'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Product_Name.id', '{{product_name}}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Case_Origin', 'Email'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Subject', 'This is a sample Case'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Case_Reason', 'User did not attend any training.'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Related_To.name', 'Patricia Boyle'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Related_To.id', '{{contact_id}}'

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/crm/v2/Cases/upsert', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "data": [
        {
            "Email": "patricia.boyle1@zylker.com",
            "Description": "This is a sample case",
            "Deal_Name": {
                "name": "Sample",
                "id": "{{deal_id}}"
            },
            "Phone": "9090909090",
            "Account_Name": {
                "name": "Sample",
                "id": "{{account_id}}"
            },
            "Solution": "This is a sample solution",
            "Status": "New",
            "Priority": "Medium",
            "Product_Name": {
                "name": "Sample Product",
                "id": "{{product_name}}"
            },
            "Case_Origin": "Email",
            "Subject": "This is a sample Case",
            "Case_Reason": "User did not attend any training.",
            "Related_To": {
                "name": "Patricia Boyle",
                "id": "{{contact_id}}"
            }
        }
    ]
}'
https://domain.com/crm/v2/Cases/upsert

Postman Collection Item JSON

{
  "name": "Cases",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Email\": \"patricia.boyle1@zylker.com\",\n            \"Description\": \"This is a sample case\",\n            \"Deal_Name\": {\n                \"name\": \"Sample\",\n                \"id\": \"{{deal_id}}\"\n            },\n            \"Phone\": \"9090909090\",\n            \"Account_Name\": {\n                \"name\": \"Sample\",\n                \"id\": \"{{account_id}}\"\n            },\n            \"Solution\": \"This is a sample solution\",\n            \"Status\": \"New\",\n            \"Priority\": \"Medium\",\n            \"Product_Name\": {\n                \"name\": \"Sample Product\",\n                \"id\": \"{{product_name}}\"\n            },\n            \"Case_Origin\": \"Email\",\n            \"Subject\": \"This is a sample Case\",\n            \"Case_Reason\": \"User did not attend any training.\",\n            \"Related_To\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"{{contact_id}}\"\n            }\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/Cases/upsert",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Cases",
        "upsert"
      ]
    },
    "description": "To upsert records in the Cases module."
  },
  "response": [
  ]
}