> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL. > > Documentation indexes by section: > - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt > - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt > - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt > - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt > > Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth > Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks > > OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json > MCP server: https://docusign.docs.buildwithfern.com/_mcp/server # How to create a brand > Demonstrates how to create a new brand using the eSignature API and SDKs This topic demonstrates how to create a brand and apply it to a Docusign envelope. > **Note** > > Run this code example from our [Quickstart](/docs/esign-rest-api/quickstart) or launcher projects: [Bash](https://github.com/docusign/code-examples-bash), [C#](https://github.com/docusign/code-examples-csharp), [Java](https://github.com/docusign/code-examples-java), [Node.js](https://github.com/docusign/code-examples-node), [PHP](https://github.com/docusign/code-examples-php), [PowerShell](https://github.com/docusign/code-examples-powershell), [Python](https://github.com/docusign/code-examples-python), or [Ruby](https://github.com/docusign/code-examples-ruby). ## Required data Running the code in this how-to requires this data: | Data element | Description | | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \{API_ACCOUNT_ID} | A [GUID](http://guid.one/) value that identifies your account. This value is automatically generated by Docusign for any account you create. Copy the value from the **API Account ID** field on the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=appsAndKeys) page. | | \{BASE_PATH} | A string value that forms the root of the URL required to make API calls. The base path value in the example code is set to target the developer environment at https\://\/restapi Where \ is demo.docusign.net for the developer environment and is the result of the GetUserInfo call in production. | ## Step 1. Obtain your OAuth token To make the API call shown in this how-to, you need a valid OAuth access token. Docusign supports access tokens for three different recommended OAuth grant types: Public Authorization Code Grant, Confidential Authorization Code Grant, and JSON Web Token (JWT) Grant. Choose the OAuth grant type appropriate for your scenario. > **Note** > > See [Confidential Authorization Code Grant](/platform/auth/authcode#confidential-authorization-code-grant) for guidance on your options to get an Confidential Authorization Code Grant OAuth token. ![Three icons that represent the three methods a user can use to obtain an OAuth token: JSON Web Token (JWT), Public Authorization Code Grant (ACG), and Confidential Authorization Code grant](/_fern-files/_img/64f473773042ee439449a096bf7673292b1585b86a4ccc55f82ba0dda41f61a1.webp) ## Step 2. Construct your API headers After you have a valid OAuth access token, you are ready to construct the API headers that you will pass to the API call. Construct your headers like this, but make sure to substitute your valid OAuth access token for \{ACCESS_TOKEN}. **`Bash`** ```bash title="Bash" declare -a Headers=('--header' "Authorization: Bearer ${ACCESS_TOKEN}" \ '--header' "Accept: application/json" \ '--header' "Content-Type: application/json") ``` **`C#`** ```csharp title="C#" var docuSignClient = new DocuSignClient(basePath); docuSignClient.Configuration.DefaultHeader.Add("Authorization", "Bearer " + accessToken); ``` **`Java`** ```java title="Java" ApiClient apiClient = new ApiClient(basePath); apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + userAccessToken); ``` **`Node.js`** ```javascript title="Node.js" let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); let accountsApi = new docusign.AccountsApi(dsApiClient); ``` **`PHP`** ```php title="PHP" $config = new Configuration(); $config->setHost($args['base_path']); $config->addDefaultHeader('Authorization', 'Bearer ' . $args['ds_access_token']); $this->apiClient = new ApiClient($config); ``` **`PowerShell`** ```text title="PowerShell" $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]" $headers.add("Authorization", "Bearer $oAuthAccessToken") $headers.add("Accept", "application/json") $headers.add("Content-Type", "application/json") ``` **`Python`** ```python title="Python" api_client = create_api_client(base_path=args["base_path"], access_token=args["access_token"]) ``` **`Ruby`** ```ruby title="Ruby" configuration = DocuSign_eSign::Configuration.new configuration.host = args[:base_path] api_client = DocuSign_eSign::ApiClient.new configuration api_client.default_headers['Authorization'] = "Bearer #{args[:access_token]}" ``` ## Step 3. Construct the request body Next, create your request body, specifying a name for your brand and a default brand language. A list of supported brand languages is available under **brandLanguages** in the expanded definition for **brand** in the [API reference](/docs/esign-rest-api/reference/accounts/accountbrands/list#schema_200_accountbrands_accountbrands_brands_brandlanguages). **`Bash`** ```bash title="Bash" printf \ '{ "brandName": "'"${BRAND}"'", "defaultBrandLanguage": "en" }' >> $request_data ``` **`C#`** ```csharp title="C#" Brand newBrand = new Brand { BrandName = brandName, DefaultBrandLanguage = defaultBrandLanguage, }; ``` **`Java`** ```java title="Java" String language = args.getLanguage(); BrandsResponse brandsResponse = CreateBrandService.createBrand( accountsApi, args.getBrandName(), language, session.getAccountId() ); ``` **`Node.js`** ```javascript title="Node.js" let callback = { brand: { brandName: args.brandName, defaultBrandLanguage: args.defaultBrandLanguage, }, }; ``` **`PHP`** ```php title="PHP" $accounts_api = $clientService->getAccountsApi(); $brand = new Brand([ 'brand_name' => $args['brand_args']['brand_name'], 'default_brand_language' => $args['brand_args']['default_language'] ]); ``` **`PowerShell`** ```text title="PowerShell" $body = @" { "brandName": "${brandName}", "defaultBrandLanguage": "en" } "@ ``` **`Python`** ```python title="Python" brand = Brand( brand_name=args["brand_name"], default_brand_language=args["default_language"], ) ``` **`Ruby`** ```ruby title="Ruby" accounts_api = DocuSign_eSign::AccountsApi.new api_client params = { brandName: args[:brandName], defaultBrandLanguage: args[:defaultBrandLanguage] } ``` ## Step 4. Call the eSignature REST API Now that you have constructed your API headers, make a request to the eSignature REST API to create a brand. Here’s how you make the call, but make sure to substitute your API account ID for \{ACCOUNT_ID}. > **Note** > > View the source code for this how-to on GitHub: [Bash](https://github.com/docusign/code-examples-bash/blob/master/examples/eSignature/eg028CreatingABrand.sh), [C#](https://github.com/docusign/code-examples-csharp/blob/master/launcher-csharp/eSignature/Examples/CreateBrand.cs), [Java](https://github.com/docusign/code-examples-java/blob/master/src/main/java/com/docusign/controller/eSignature/services/CreateBrandService.java), [Node.js](https://github.com/docusign/code-examples-node/blob/master/lib/eSignature/examples/createBrand.js), [PHP](https://github.com/docusign/code-examples-php/blob/master/src/Services/Examples/eSignature/CreateBrandService.php), [PowerShell](https://github.com/docusign/code-examples-powershell/blob/master/examples/eSignature/eg028CreatingABrand.ps1), [Python](https://github.com/docusign/code-examples-python/blob/master/app/eSignature/examples/eg028_brand_creating.py), or [Ruby](https://github.com/docusign/code-examples-ruby/blob/main/app/services/e_sign/eg028_brands_creating_service.rb). **`Bash`** ```bash title="Bash" Status=$(curl -w '%{http_code}' -i --request POST ${base_path}/v2.1/accounts/${account_id}/brands \ "${Headers[@]}" \ --data-binary @${request_data} \ --output ${response}) ``` **`C#`** ```csharp title="C#" AccountsApi accountsApi = new AccountsApi(docuSignClient); var response = accountsApi.CreateBrandWithHttpInfo(accountId, newBrand); response.Headers.TryGetValue("X-RateLimit-Remaining", out string remaining); response.Headers.TryGetValue("X-RateLimit-Reset", out string reset); if (reset != null && remaining != null) { DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime; Console.WriteLine("API calls remaining: " + remaining); Console.WriteLine("Next Reset: " + resetDate); } return response.Data; ``` **`Java`** ```java title="Java" var brandResponse = accountsApi.createBrandWithHttpInfo(accountId, brand); Map> headers = brandResponse.getHeaders(); java.util.List remaining = headers.get("X-RateLimit-Remaining"); java.util.List reset = headers.get("X-RateLimit-Reset"); if (remaining != null & reset != null) { Instant resetInstant = Instant.ofEpochSecond(Long.parseLong(reset.get(0))); System.out.println("API calls remaining: " + remaining); System.out.println("Next Reset: " + resetInstant); } return brandResponse.getData(); ``` **`Node.js`** ```javascript title="Node.js" results = await accountsApi.createBrand(args.accountId, callback, (error, data, response) => { const headers = response?.headers; const remaining = headers?.['x-ratelimit-remaining']; const reset = headers?.['x-ratelimit-reset']; if (remaining && reset) { const resetInstant = new Date(Number(reset) * 1000); console.log(`API calls remaining: ${remaining}`); console.log(`Next Reset: ${resetInstant.toISOString()}`); } }); return results.data; ``` **`PHP`** ```php title="PHP" $createdBrand = $accounts_api->createBrandWithHttpInfo( $args['account_id'], $brand ); $remaining = $createdBrand[2]['X-RateLimit-Remaining'] ?? null; $reset = $createdBrand[2]['X-RateLimit-Reset'] ?? null; if ($remaining !== null && $reset !== null) { $resetInstant = (new DateTime())->setTimestamp((int)$reset); error_log("API calls remaining: $remaining"); error_log("Next Reset: " . $resetInstant->format(\DateTime::ATOM)); } ``` **`PowerShell`** ```text title="PowerShell" $uri = "https://demo.docusign.net/restapi/v2.1/accounts/$APIAccountId/brands" try { Write-Output "Response:" $response = Invoke-WebRequest -uri $uri -headers $headers -body $body -method POST $($response.Content | ConvertFrom-Json).brands.brandId > .\config\BRAND_ID $response.Content | ConvertFrom-Json | ConvertTo-Json } catch { Write-Output "Unable to create a new brand." # On failure, display a notification, X-DocuSign-TraceToken, error message, and the command that triggered the error foreach ($header in $_.Exception.Response.Headers) { if ($header -eq "X-DocuSign-TraceToken") { Write-Output "TraceToken : " $_.Exception.Response.Headers[$int] } $int++ } Write-Output "Error : "$_.ErrorDetails.Message Write-Output "Command : "$_.InvocationInfo.Line } ``` **`Python`** ```python title="Python" account_api = AccountsApi(api_client) (response, status, headers) = account_api.create_brand_with_http_info(account_id=args["account_id"], brand=brand) remaining = headers.get("X-RateLimit-Remaining") reset = headers.get("X-RateLimit-Reset") if remaining is not None and reset is not None: reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc) print(f"API calls remaining: {remaining}") print(f"Next Reset: {reset_date}") ``` **`Ruby`** ```ruby title="Ruby" results, _status, headers = accounts_api.create_brand_with_http_info(args[:account_id], params) remaining = headers['X-RateLimit-Remaining'] reset = headers['X-RateLimit-Reset'] if remaining && reset reset_date = Time.at(reset.to_i).utc puts "API calls remaining: #{remaining}" puts "Next Reset: #{reset_date}" end ``` ## Expected response If you run this code example from our Quickstart or launcher projects, you should see a JSON response similar to the code shown. **`Sample response`** ```json title="Sample response" { "brands": [ { "brandId": "f49afdfe-xxxx-xxxx-xxxx-adbe837c7e5c", "brandName": "Sample Corp 2020-08-04", "brandLanguages": [ "ar", "bg", "cs", "da", "de", "el", "en", "en_GB", "es", "es_MX", "et", "fa", "fi", "fr", "fr_CA", "he", "hi", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "nl", "no", "pl", "pt", "pt_BR", "ro", "ru", "sk", "sl", "sr", "sv", "th", "tr", "uk", "vi", "zh_CN", "zh_TW", "hy" ], "defaultBrandLanguage": "en" } ] } ``` ## Next steps * Run this code example from our [Quickstart](/docs/esign-rest-api/quickstart) or launcher projects: [Bash](https://github.com/docusign/code-examples-bash), [C#](https://github.com/docusign/code-examples-csharp), [Java](https://github.com/docusign/code-examples-java), [Node.js](https://github.com/docusign/code-examples-node), [PHP](https://github.com/docusign/code-examples-php), [PowerShell](https://github.com/docusign/code-examples-powershell), [Python](https://github.com/docusign/code-examples-python), or [Ruby](https://github.com/docusign/code-examples-ruby). * Learn more about [branding](/docs/esign-rest-api/esign101/concepts/branding). * See how to [Go-Live](/docs/esign-rest-api/go-live) with a completed app and find the base path for API calls in the production environment.