Delete brand profiles

DELETE

/v2.1/accounts/:accountId/brands

DELETE

/restapi/v2.1/accounts/:accountId/brands

curl -X DELETE https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/brands \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "brands": [
    {
      "brandId": "sample string 1"
    }
  ]
}'

{
  "brands": [
    {
      "brandCompany": "sample string 1",
      "brandId": "sample string 2",
      "brandLanguages": [
        "sample string 1"
      ],
      "brandName": "sample string 3",
      "colors": [
        {
          "errorDetails": {
            "errorCode": "sample string 1",
            "message": "sample string 2"
          },
          "name": "sample string 1",
          "originalValue": "sample string 2",
          "value": "sample string 3"
        }
      ],
      "defaultBrandLanguage": "sample string 4",
      "emailContent": [
        {
          "content": "sample string 1",
          "emailContentType": "sample string 2",
          "emailToLink": "sample string 3",
          "linkText": "sample string 4"
        }
      ],
      "isOrganizationBrand": "sample string 5",
      "isOverridingCompanyName": true,
      "isSendingDefault": true,
      "isSigningDefault": true,
      "landingPages": [
        {}
      ],
      "links": [
        {
          "linkText": "sample string 1",
          "linkType": "sample string 2",
          "showLink": "sample string 3",
          "urlOrMailTo": "sample string 4"
        }
      ],
      "logoIds": {
        "emailLogoId": "sample string 1",
        "primaryLogoId": "sample string 2",
        "secondaryLogoId": "sample string 3"
      },
      "logos": {
        "email": "sample string 1",
        "primary": "sample string 2",
        "secondary": "sample string 3"
      },
      "organizationBrandLogo": "sample string 6",
      "resources": {
        "email": "sample string 1",
        "sending": "sample string 2",
        "signing": "sample string 3",
        "signingCaptive": "sample string 4"
      }
    }
  ],
  "recipientBrandIdDefault": "sample string 1",
  "senderBrandIdDefault": "sample string 2"
}

This method deletes one or more brand profiles from an account, based on the brand IDs that you include in the brandsRequest.

Either or both of the following settings must be enabled for the account to use this method:

canSelfBrandSign
canSelfBrandSend

How to create a brand

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

The external account number (int) or account ID Guid.

Request

This endpoint expects an object: brandsRequest

brandslist of objectsOptional

A list of brands.

Response

Successful response.

brandslist of objectsOptional

The list of brands.

recipientBrandIdDefaultstringOptional

The brand seen by envelope recipients when a brand is not explicitly set.

senderBrandIdDefaultstringOptional

The brand seen by envelope senders when a brand is not explicitly set.

Errors

400

Bad Request Error

Related topics

Authentication

Path parameters

Request

Response

Errors