Upload DocuSign Brand Profiles

390 views Asked by At

What is the structure and contents of the .ZIP that needs to be uploaded to DocuSign using the REST API for uploading a new brand profile?

The online documentation is pretty sparse: https://www.docusign.com/p/RESTAPIGuide/Content/REST%20API%20References/Upload%20Brand%20Profiles.htm

POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/brands

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><IntegratorKey>{integrator_key}</IntegratorKey></DocuSignCredentials>
Accept: application/json
Content-Type: application/zip

<base64bytes brand zip file removed for brevity>

When I send (PHP+cURL) a zip archive of the the exported master resource files, it succeeds but creates three random imported brands:

branding.zip
  |__ DocuSign_EmailResources.xml
  |__ DocuSign_SendResources.xml
  |__ DocuSign_SignResources.xml

I've also attempted exporting a previously created branding in the DocuSign developer console (truncated example below):

<Brand><BrandId>ce173f6e-3549-4494-a8ea-f8f33a0dba64</BrandId><BrandName>ExampleBrand</BrandName><CompanyName>Example Co. Ltd</CompanyName><BackgroundColor>#F3F3F3</BackgroundColor><BackgroundTextColor>#FFFFFF</BackgroundTextColor> [TRUNCATED]

The complete Brand XML is available here: https://gist.github.com/anonymous/022b3d1491a27e75f3ac

Then created the archive from that single XML file.

branding.zip
  |__ Brand_ExampleBrand.xml

When uploading it with the API it results in this error:

BRAND_CREATE_FAILED: Brands could not be created. Unable to upload brand Brand_ExampleBrand.xml, error: Could not find any recognizable digits.

What is the correct way to use this endpoint?

0

There are 0 answers