Chilkat Online Tools

delphiAx / DocuSign REST API / Updates an existing brand.

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
resp: IChilkatHttpResponse;

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

http := TChilkatHttp.Create(Self);

// 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 := TChilkatJsonObject.Create(Self);
json.UpdateString('brandCompany','sample string 1');
json.UpdateString('brandId','sample string 2');
json.UpdateString('brandName','sample string 3');
json.UpdateString('isOverridingCompanyName','sample string 4');
json.UpdateString('isSendingDefault','sample string 5');
json.UpdateString('isSigningDefault','sample string 6');
json.UpdateString('links[0].linkType','sample string 1');
json.UpdateString('links[0].urlOrMailTo','sample string 2');
json.UpdateString('links[0].linkText','sample string 3');
json.UpdateString('links[0].showLink','sample string 4');
json.UpdateString('emailContent[0].emailContentType','sample string 1');
json.UpdateString('emailContent[0].content','sample string 2');
json.UpdateString('emailContent[0].emailToLink','sample string 3');
json.UpdateString('emailContent[0].linkText','sample string 4');
json.UpdateString('logos.primary','sample string 1');
json.UpdateString('logos.secondary','sample string 2');
json.UpdateString('logos.email','sample string 3');
json.UpdateString('resources.email','sample string 1');
json.UpdateString('resources.sending','sample string 2');
json.UpdateString('resources.signing','sample string 3');
json.UpdateString('resources.signingCaptive','sample string 4');

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken := '{{accessToken}}';
http.SetRequestHeader('Accept','application/json');

sbRequestBody := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbRequestBody.ControlInterface);

resp := http.PTextSb('PUT','https://domain.com/v2.1/accounts/{{accountId}}/brands/{{brandId}}',sbRequestBody.ControlInterface,'utf-8','application/json',0,0);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add(IntToStr(resp.StatusCode));
Memo1.Lines.Add(resp.BodyStr);

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": [
  ]
}