Add brand to group

PUT

/v2/accounts/:accountId/groups/:groupId/brands

PUT

/restapi/v2/accounts/:accountId/groups/:groupId/brands

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

{
  "recipientBrandIdDefault": "string",
  "senderBrandIdDefault": "string",
  "brandOptions": [
    {
      "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"
      }
    }
  ]
}

Adds group brand ID information to a group.

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.

groupIdstringRequired

The ID of the group being accessed.

Request

This endpoint expects an object: brandsRequest

brandslist of objectsOptional

The list of brands.

Response

Successful response.

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.

brandOptionslist of objectsOptional

The list of brands.

Errors

400

Bad Request Error