Delete brand profiles

DELETE

/v2/accounts/:accountId/brands

DELETE

/restapi/v2/accounts/:accountId/brands

curl -X DELETE https://demo.docusign.net/restapi/v2/accounts/accountId/brands \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "brands": [
    {
      "brandCompany": "string",
      "brandId": "string",
      "brandName": "string",
      "colors": [
        {
          "errorDetails": {
            "errorCode": "string",
            "message": "string"
          },
          "name": "string",
          "originalValue": "string",
          "value": "string"
        }
      ],
      "emailContent": [
        {
          "content": "string",
          "emailContentType": "string",
          "emailToLink": "string",
          "linkText": "string"
        }
      ],
      "errorDetails": {
        "errorCode": "string",
        "message": "string"
      },
      "isOverridingCompanyName": "string",
      "isSendingDefault": "string",
      "isSigningDefault": "string",
      "landingPages": [
        {
          "errorDetails": {
            "errorCode": "string",
            "message": "string"
          },
          "name": "string",
          "originalValue": "string",
          "value": "string"
        }
      ],
      "links": [
        {
          "linkText": "string",
          "linkType": "string",
          "showLink": "string",
          "urlOrMailTo": "string"
        }
      ],
      "logos": {
        "email": "string",
        "primary": "string",
        "secondary": "string"
      },
      "resources": {
        "email": "string",
        "sending": "string",
        "signing": "string",
        "signingCaptive": "string"
      }
    }
  ],
  "recipientBrandIdDefault": "string",
  "senderBrandIdDefault": "string"
}

Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties canSelfBrandSend and canSelfBrandSend) must be set to true to use this call.

Authentication

Authorizationstring

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token>.

Path parameters

accountIdstringRequired

The external account number (int) or account id GUID.

Request

This endpoint expects an object: brandsRequest

brandslist of objectsOptional

The 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