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.
-- {
-- "brandCompany": "sample string 1",
-- "brandId": "sample string 2",
-- "brandName": "sample string 3",
-- "colors": [
-- {}
-- ],
-- "isOverridingCompanyName": "sample string 4",
-- "isSendingDefault": "sample string 5",
-- "isSigningDefault": "sample string 6",
-- "landingPages": [
-- {}
-- ],
-- "links": [
-- {
-- "linkType": "sample string 1",
-- "urlOrMailTo": "sample string 2",
-- "linkText": "sample string 3",
-- "showLink": "sample string 4"
-- }
-- ],
-- "emailContent": [
-- {
-- "emailContentType": "sample string 1",
-- "content": "sample string 2",
-- "emailToLink": "sample string 3",
-- "linkText": "sample string 4"
-- }
-- ],
-- "logos": {
-- "primary": "sample string 1",
-- "secondary": "sample string 2",
-- "email": "sample string 3"
-- },
-- "resources": {
-- "email": "sample string 1",
-- "sending": "sample string 2",
-- "signing": "sample string 3",
-- "signingCaptive": "sample string 4"
-- }
-- }
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, 'brandCompany', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'brandId', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'brandName', 'sample string 3'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'isOverridingCompanyName', 'sample string 4'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'isSendingDefault', 'sample string 5'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'isSigningDefault', 'sample string 6'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'links[0].linkType', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'links[0].urlOrMailTo', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'links[0].linkText', 'sample string 3'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'links[0].showLink', 'sample string 4'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'emailContent[0].emailContentType', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'emailContent[0].content', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'emailContent[0].emailToLink', 'sample string 3'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'emailContent[0].linkText', 'sample string 4'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'logos.primary', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'logos.secondary', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'logos.email', 'sample string 3'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'resources.email', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'resources.sending', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'resources.signing', 'sample string 3'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'resources.signingCaptive', 'sample string 4'
-- Adds the "Authorization: Bearer {{accessToken}}" header.
EXEC sp_OASetProperty @http, 'AuthToken', '{{accessToken}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://domain.com/v2.1/accounts/{{accountId}}/brands/{{brandId}}', @sbRequestBody, 'utf-8', 'application/json', 0, 0
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
EXEC @hr = sp_OADestroy @sbRequestBody
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
EXEC @hr = sp_OADestroy @sbRequestBody
END
GO
Curl Command
curl -X PUT
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"brandCompany": "sample string 1",
"brandId": "sample string 2",
"brandName": "sample string 3",
"colors": [
{}
],
"isOverridingCompanyName": "sample string 4",
"isSendingDefault": "sample string 5",
"isSigningDefault": "sample string 6",
"landingPages": [
{}
],
"links": [
{
"linkType": "sample string 1",
"urlOrMailTo": "sample string 2",
"linkText": "sample string 3",
"showLink": "sample string 4"
}
],
"emailContent": [
{
"emailContentType": "sample string 1",
"content": "sample string 2",
"emailToLink": "sample string 3",
"linkText": "sample string 4"
}
],
"logos": {
"primary": "sample string 1",
"secondary": "sample string 2",
"email": "sample string 3"
},
"resources": {
"email": "sample string 1",
"sending": "sample string 2",
"signing": "sample string 3",
"signingCaptive": "sample string 4"
}
}'
https://domain.com/v2.1/accounts/{{accountId}}/brands/{{brandId}}
Postman Collection Item JSON
{
"name": "Updates an existing brand.",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"brandCompany\": \"sample string 1\",\n \"brandId\": \"sample string 2\",\n \"brandName\": \"sample string 3\",\n \"colors\": [\n {}\n ],\n \"isOverridingCompanyName\": \"sample string 4\",\n \"isSendingDefault\": \"sample string 5\",\n \"isSigningDefault\": \"sample string 6\",\n \"landingPages\": [\n {}\n ],\n \"links\": [\n {\n \"linkType\": \"sample string 1\",\n \"urlOrMailTo\": \"sample string 2\",\n \"linkText\": \"sample string 3\",\n \"showLink\": \"sample string 4\"\n }\n ],\n \"emailContent\": [\n {\n \"emailContentType\": \"sample string 1\",\n \"content\": \"sample string 2\",\n \"emailToLink\": \"sample string 3\",\n \"linkText\": \"sample string 4\"\n }\n ],\n \"logos\": {\n \"primary\": \"sample string 1\",\n \"secondary\": \"sample string 2\",\n \"email\": \"sample string 3\"\n },\n \"resources\": {\n \"email\": \"sample string 1\",\n \"sending\": \"sample string 2\",\n \"signing\": \"sample string 3\",\n \"signingCaptive\": \"sample string 4\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/brands/{{brandId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"brands",
"{{brandId}}"
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}",
"type": "string"
},
{
"key": "brandId",
"value": "{{brandId}}",
"type": "string"
}
]
}
},
"response": [
]
}
