Chilkat Online Tools

delphiAx / DocuSign REST API / Gets a list of brand profiles.

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
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);

queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('exclude_distributor_brand','{{exclude_distributor_brand}}');
queryParams.UpdateString('include_logos','{{include_logos}}');

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

resp := http.QuickRequestParams('GET','https://domain.com/v2.1/accounts/{{accountId}}/brands',queryParams.ControlInterface);
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 -G -d "exclude_distributor_brand=%7B%7Bexclude_distributor_brand%7D%7D"
	-d "include_logos=%7B%7Binclude_logos%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/brands

Postman Collection Item JSON

{
  "name": "Gets a list of brand profiles.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/brands?exclude_distributor_brand={{exclude_distributor_brand}}&include_logos={{include_logos}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "brands"
      ],
      "query": [
        {
          "key": "exclude_distributor_brand",
          "value": "{{exclude_distributor_brand}}"
        },
        {
          "key": "include_logos",
          "value": "{{include_logos}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    },
    "description": "Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`)  must be set to **true** for the account to use this call."
  },
  "response": [
  ]
}