--- title: "Create and edit general brand resource" method: PUT path: "/v2/brands/{brand_id}/resources/general" --- # Create and edit general brand resource `PUT /v2/brands/{brand_id}/resources/general` ## Request - Base URL: `https://api.signnow.com` - URL: `https://api.signnow.com/v2/brands/{brand_id}/resources/general` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) This endpoint allows users to create and update a general brand resource. Learn more about the [general brand resource](/docs/branding-general-resource). Note: to create a general resource for a brand, you need to own the brand. ## Request body - object - `icons` object: Icons object that contains attributes for all icons in the resource. - `color` string: Text color in HEX color code. - `border` string: Border color in HEX color code. - `background` string: Background color in HEX color code. - `hover-color` string: Text color in HEX color code when the button is hovered over. - `hover-border` string: Border color in HEX color code when the button is hovered over. - `hover-background` string: Background color in HEX color code when the button is hovered over. - `texts` object: Text object that contains attributes for texts in the resource. - `color` string: Text color in the HEX color code. - `header` object: Header object. Contains attributes for headers. - `background` string: Background color in HEX color code. - `buttons` object: Button object that contains `primary`, `secondary`, `default`, and `dropdown` button attributes. - `default` object: Default button object. - `color` string: Text color in HEX color code. - `border` string: Border color in HEX color code. - `background` string: Background color in HEX color code. - `hover-color` string: Text color in HEX color code when the button is hovered over. - `active-color` string: Text color in HEX color code when the button is active. - `hover-border` string: Border color in HEX color code when the button is hovered over. - `active-border` string: Border color in HEX color code when the button is active. - `hover-background` string: Background color in HEX color code when the button is hovered over. - `active-background` string: Background color in HEX color code when the button is active. - `primary` object: Primary button object. - `color` string: Text color in HEX color code. - `border` string: Border color in HEX color code. - `background` string: Background color in HEX color code. - `hover-color` string: Text color in HEX color code when the button is hovered over. - `active-color` string: Text color in HEX color code when the button is active. - `hover-border` string: Border color in HEX color code when the button is hovered over. - `active-border` string: Border color in HEX color code when the button is active. - `hover-background` string: Background color in HEX color code when the button is hovered over. - `active-background` string: Background color in HEX color code when the button is active. - `dropdown` object: Dropdown button object. - `color` string: Text color in HEX color code. - `border` string: Border color in HEX color code. - `background` string: Background color in HEX color code. - `hover-color` string: Text color in HEX color code when the button is hovered over. - `active-color` string: Text color in HEX color code when the button is active. - `hover-border` string: Border color in HEX color code when the button is hovered over. - `active-border` string: Border color in HEX color code when the button is active. - `hover-background` string: Background color in HEX color code when the button is hovered over. - `active-background` string: Background color in HEX color code when the button is active. - `secondary` object: Secondary button object. - `color` string: Text color in HEX color code. - `border` string: Border color in HEX color code. - `background` string: Background color in HEX color code. - `hover-color` string: Text color in HEX color code when the button is hovered over. - `active-color` string: Text color in HEX color code when the button is active. - `hover-border` string: Border color in HEX color code when the button is hovered over. - `active-border` string: Border color in HEX color code when the button is active. - `hover-background` string: Background color in HEX color code when the button is hovered over. - `active-background` string: Background color in HEX color code when the button is active. - `hyperlink` object: Defines hyperlink colors for default, hover, and active (clicked) states. Available for embedded sending and embedded editor. - `color` string: Default color of the hyperlink text in HEX color code. - `hover-color` string: Color of the hyperlink text when hovered in HEX color code. - `active-color` string: Color of the hyperlink text when clicked in HEX color code. - `help-center` object - `visibility` boolean: Whether the button with a link to signNow help center should be visible or not. - `consent-text` object: Consent text object that contains attributes for consent text that appears when a signer opens the document. Consent text appears if sender is in organization and consent text is enabled for the organization. - `en` string: Custom consent text in English that can be updated. Placeholder {sender_email} is available. - `es` string: Custom consent text in Spanish that can be updated. Placeholder {sender_email} is available. - `fr` string: Custom consent text in French that can be updated. Placeholder {sender_email} is available. - `main-background` string: Main background color in HEX color code. - `welcome-message` object: Welcome message object that contains attributes for a welcome message that appears when a signer opens the document or clicks the notification icon on the header. - `body-text` object: Custom welcome message. - `en` string: Custom welcome message in English that can be updated. Placeholder {sender_email} is available. - `es` string: Custom welcome message in Spanish that can be updated. Placeholder {sender_email} is available. - `fr` string: Custom welcome message in French that can be updated. Placeholder {sender_email} is available. - `visibility` boolean: Whether a welcome message should appear or not. - `header-text` object: Custom text displayed in the welcome message header. - `en` string: Custom header text in English. The placeholder `{signer_email}` is replaced with the recipient's name or email/phone number (for regular documents); name or email (for embedded invites); name or “Guest Signer” (for signing links); and “Guest Signer” (for document group signing links). - `es` string: Custom header text in Spanish. The placeholder `{signer_email}` is replaced with the recipient's name or email/phone number (for regular documents); name or email (for embedded invites); name or “Guest Signer” (for signing links); and “Guest Signer” (for document group signing links). - `fr` string: Custom header text in French. The placeholder `{signer_email}` is replaced with the recipient's name or email/phone number (for regular documents); name or email (for embedded invites); name or “Guest Signer” (for signing links); and “Guest Signer” (for document group signing links). ## Response `204` Success, no content - object ## Other responses - `400`: * Incorrect or missing token. * Request body is incorrect or missing. * `header` is not an array. * `color` is not a string. * `background` is not a string. * `border` is not a string. * `hover-color` is not a string. * `hover-background` is not a string. * `hover-border` is not a string. * `active-color` is not a string. * `active-background` is not a string. * `active-border` is not a string. * `main-background` is not a string. * `consent-text` is not an array. * `consent-text` value is not a string. * `welcome-message` is not an array. * `welcome-message.visibility` value is not a boolean. * `welcome-message.body-text` is not an array. * `body-text` value is not a string. * `help-center` is not an array. * `help-center.visibility` is not a boolean. * The `hyperlink` is not an array. * The `hyperlink.color` is not a string. * The `hyperlink.color` is not a valid HTML color format. * The `hyperlink.hover-color` is not a string. * The `hyperlink.hover-color` is not a valid HTML color format. * The `hyperlink.active-color` is not a string. * The `hyperlink.active-color` is not a valid HTML color format. - `403`: * Request with a valid bearer token from another user logged in. * The user is authorized with a token from an app they don’t own. - `404`: * Brand with this `brand_id` doesn't exist. * Missing or incorrect `brand_id`. --- [API](https://skmtc.dev/signnow/apis/signnow-api.md) - [All operations](https://skmtc.dev/signnow/apis/signnow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signnow/apis/signnow-api/revisions/1c9c30a6142b?raw)