Chilkat Online Tools

Android / DocuSign eSignature REST API / Creates one or more brand profile files for the account.

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkHttp http = new CkHttp();
    boolean success;

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

    CkJsonObject json = new CkJsonObject();
    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.put_AuthToken("{{accessToken}}");
    http.SetRequestHeader("Accept","application/json");

    CkHttpResponse resp = http.PostJson3("https://domain.com/v2.1/accounts/{{accountId}}/brands","application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    Log.i(TAG, String.valueOf(resp.get_StatusCode()));
    Log.i(TAG, resp.bodyStr());


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

Curl Command

curl -X POST
	-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

Postman Collection Item JSON

{
  "name": "Creates one or more brand profile files for the account.",
  "request": {
    "method": "POST",
    "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",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "brands"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        }
      ]
    },
    "description": "Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call.\n\nAn error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version.\n\nWhen brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`."
  },
  "response": [
  ]
}