Chilkat Online Tools

C / DocuSign REST API / Updates an existing brand.

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkStringBuilder sbRequestBody;
    HCkHttpResponse resp;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    http = CkHttp_Create();

    // 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"
    //   }
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"brandCompany","sample string 1");
    CkJsonObject_UpdateString(json,"brandId","sample string 2");
    CkJsonObject_UpdateString(json,"brandName","sample string 3");
    CkJsonObject_UpdateString(json,"isOverridingCompanyName","sample string 4");
    CkJsonObject_UpdateString(json,"isSendingDefault","sample string 5");
    CkJsonObject_UpdateString(json,"isSigningDefault","sample string 6");
    CkJsonObject_UpdateString(json,"links[0].linkType","sample string 1");
    CkJsonObject_UpdateString(json,"links[0].urlOrMailTo","sample string 2");
    CkJsonObject_UpdateString(json,"links[0].linkText","sample string 3");
    CkJsonObject_UpdateString(json,"links[0].showLink","sample string 4");
    CkJsonObject_UpdateString(json,"emailContent[0].emailContentType","sample string 1");
    CkJsonObject_UpdateString(json,"emailContent[0].content","sample string 2");
    CkJsonObject_UpdateString(json,"emailContent[0].emailToLink","sample string 3");
    CkJsonObject_UpdateString(json,"emailContent[0].linkText","sample string 4");
    CkJsonObject_UpdateString(json,"logos.primary","sample string 1");
    CkJsonObject_UpdateString(json,"logos.secondary","sample string 2");
    CkJsonObject_UpdateString(json,"logos.email","sample string 3");
    CkJsonObject_UpdateString(json,"resources.email","sample string 1");
    CkJsonObject_UpdateString(json,"resources.sending","sample string 2");
    CkJsonObject_UpdateString(json,"resources.signing","sample string 3");
    CkJsonObject_UpdateString(json,"resources.signingCaptive","sample string 4");

    // Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttp_putAuthToken(http,"{{accessToken}}");
    CkHttp_SetRequestHeader(http,"Accept","application/json");

    sbRequestBody = CkStringBuilder_Create();
    CkJsonObject_EmitSb(json,sbRequestBody);

    resp = CkHttp_PTextSb(http,"PUT","https://domain.com/v2.1/accounts/{{accountId}}/brands/{{brandId}}",sbRequestBody,"utf-8","application/json",FALSE,FALSE);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbRequestBody);
        return;
    }

    printf("%d\n",CkHttpResponse_getStatusCode(resp));
    printf("%s\n",CkHttpResponse_bodyStr(resp));
    CkHttpResponse_Dispose(resp);


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbRequestBody);

    }

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}}"
        },
        {
          "key": "brandId",
          "value": "{{brandId}}"
        }
      ]
    }
  },
  "response": [
  ]
}