--- title: "Create and edit editor brand resource" method: PUT path: "/v2/brands/{brand_id}/resources/editor" --- # Create and edit editor brand resource `PUT /v2/brands/{brand_id}/resources/editor` ## Request - Base URL: `https://api.signnow.com` - URL: `https://api.signnow.com/v2/brands/{brand_id}/resources/editor` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) This endpoint allows users to create and update an editor brand resource. Learn more about the [editor brand resource](/docs/branding-editor-resource). Note: to create an editor resource for a brand, you need to own the brand. ## Request body - object - `fields` object: Settings of the fields panel on the left sidebar. Available for embedded sending, embedded editor, and FreeForm invite. - `date` object: Whether to show the date field in the fields panel. - `visibility` boolean - `text` object: Whether to show the text field in the fields panel. - `visibility` boolean - `email` object: Whether to show the email field in the fields panel. - `visibility` boolean - `stamp` object: Whether to show the stamp field in the fields panel. - `visibility` boolean - `formula` object: Whether to show the formula field in the fields panel. - `visibility` boolean - `checkbox` object: Whether to show the checkbox field in the fields panel. - `visibility` boolean - `dropdown` object: Whether to show the dropdown field in the fields panel. - `visibility` boolean - `fullname` object: Whether to show the fullname field in the fields panel. - `visibility` boolean - `initials` object: Whether to show the initials field in the fields panel. - `visibility` boolean - `hyperlink` object: Whether to show the hyperlink field in the fields panel. - `visibility` boolean - `signature` object: Whether to show the signature field in the fields panel. - `visibility` boolean - `attachment` object: Whether to show the attachment field in the fields panel. - `visibility` boolean - `radiobutton` object: Whether to show the radiobutton field in the fields panel. - `visibility` boolean - `sidebar` object - `background` string: Background color for a signing session sidebar in HEX color code. - `visibility` boolean: Whether the sidebar should be visible or not. - `toolbar` object: Configuration of the toolbar in the header. Available for embedded sending and embedded editor. - `background` string: Background color of the toolbar in HEX color code. - `visibility` boolean: Whether to show the toolbar in the header. - `settings` object: Settings object that contains attributes for the **More Actions** dropdown button. - `visibility` boolean: Whether to show or hide the **More Actions** button. - `auth-page` object: An object that customizes the authentication page for invites protected by two-factor authentication, including phone calls, SMS, and passwords set by the sender. The `auth-page` is available for document and document group field invites, as well as embedded document and document group invites. - `check-pin` object: Customizes text prompting the signer to enter the password. - `phone` object: Customizes text for phone/SMS-protected invites. - `body-text` object: Custom text displayed for phone/SMS-protected invites. - `en` string: Custom text in English. - `es` string: Custom text in Spanish. - `fr` string: Custom text in French. - `password` object: Customizes text for password-protected invites. - `body-text` object: Custom text displayed for password-protected invites. - `en` string: Custom text in English. - `es` string: Custom text in Spanish. - `fr` string: Custom text in French. - `header-text` object: Customizes a header text displayed to the signer on the two-factor authentication page. - `en` string: Custom header text in English. Placeholders `{sender_email}` and `{document_name}` are available. - `es` string: Custom header text in Spanish. Placeholders `{sender_email}` and `{document_name}` are available. - `fr` string: Custom header text in French. Placeholders `{sender_email}` and `{document_name}` are available. - `request-pin` object: Customizes text with instructions for obtaining a password via voice call or SMS. Displayed only for phone/SMS-protected invites. - `body-text` object: Custom text displayed to the signer with instructions for obtaining a password. - `en` string: Custom text with instructions in English. - `es` string: Custom text with instructions in Spanish. - `fr` string: Custom text with instructions in French. - `navigation` object: Navigation object that contains attributes for the navigation elements. - `visibility` boolean: Whether to show or hide the navigation elements. - `sender-info` object - `visibility` boolean: Whether the **Contact Sender** option on the **More Actions** menu should be visible or not. - `contact-name` string: The name of the sender that should appear if a signer clicks **Contact Sender**. - `contact-email` string: The email of the sender that should appear if a signer clicks **Contact Sender**. - `close-button` object: Object that defines the visibility and text for the closing options. - `title` object: Localized text for the closing options in signing session, embedded sending and editor modes. - `editor` object: Customizes text of the **Save and Close** button in the editor. Available for the embedded editor and embedded sending mode. - `en` string: Button title in English. - `es` string: Button title in Spanish. - `fr` string: Button title in French. - `signing` object: Customizes text of the **Save Progress and Finish Later** option during the signing session. - `en` string: Text in English for signing session. - `es` string: Text in Spanish for signing session. - `fr` string: Text in French for signing session. - `visibility` boolean: Whether the **Close** button (in the header in view mode) or **Save progress and Finish Later** option (in the **More Actions** menu during the signing session) should be visible. - `progress-bar` object: Progress bar object that contains attributes for the progress bar elements. - `default-color` string: Default color of the progress bar. - `completed-color` string: Progress bar color when the signer has completed or partially completed the invite to sign. - `support-chat` object - `visibility` string: Whether the support chat icon should be visible or not. - `accessibility` object: Accessibility object that contains attributes for the accessibility button. - `color` string: Text color of the button in HEX color code. - `border` string: Border color of the button in HEX color code. - `enabled` boolean: Whether to enable or disable the accessibility mode. By default accessibility is off. - `background` string: Background color of the button in HEX color code. - `visibility` boolean: Whether to show or hide the accessibility option in the **More Actions** menu. - `hover-color` string: Text color of the button in HEX color code when the accessibility button is hovered over. - `active-color` string: Text color of the button in HEX color code when accessibility is on. - `hover-border` string: Border button color in HEX color code when the accessibility button is hovered over. - `active-border` string: Border button color in HEX color code when accessibility is on. - `hover-background` string: Background button color in HEX color code when the accessibility button is hovered over. - `active-background` string: Background button color in HEX color code when accessibility is on. - `complete-page` object: Customization of the page that opens after a document is signed or declined. - `decline` object: Custom text that appears on the page after a signer confirms declining a document. - `body-text` object - `en` string: Decline main text in English. - `es` string: Decline main text in Spanish. - `fr` string: Decline main text in French. - `header-text` object - `en` string: Decline header text in English. - `es` string: Decline header text in Spanish. - `fr` string: Decline header text in French. - `success` object: Custom text that appears on the page after a signer completes a document. - `body-text` object - `en` string: Success main text in English. - `es` string: Success main text in Spanish. - `fr` string: Success main text in French. - `header-text` object - `en` string: Success header text in English. - `es` string: Success header text in Spanish. - `fr` string: Success header text in French. - `registration` object - `visibility` boolean: Whether the registration button on the completion page should be visible or not for new users. - `button-download` object - `visibility` boolean: Whether the button to download a document on the completion page should be visible or not. - `button-to-signnow` object - `visibility` boolean: Whether the button with a link to signNow on the completion page should be visible or not. - `document-name` object: Configuration of the document name. Available for embedded signing, embedded sending (in the editor), embedded editor, FreeForm invite, and embedded view. - `visibility` boolean: Whether to show the document name in the header. - `editing-tools` object: Configuration of the left-side editing tools panel. Available for embedded sending, embedded editor, and FreeForm invite. - `background` string: Background color of the editing tools panel in HEX color code. - `decline-button` object: An object that determines the availability of the decline option to the recipient. - `visibility` boolean: Whether the **Decline** option should be visible in the **More Actions** menu. - `default-fields` object: Configuration of the Default fields tab. Available for embedded sending and embedded editor. - `visibility` boolean: Whether to show the Default fields tab in the left sidebar. When set to `false`, the Custom fields tab becomes the only tab and the Default / Custom fields tab switcher disappears. The default value is `true`. - `field-settings` object: Configuration of the Element settings in the right sidebar. The Element settings allows users to customize field settings. Available for embedded sending and embedded editor. - `visibility` boolean: Whether to show the Element settings button on the right side of the header. The default value is `true`. - `page-dimension` object - `percent` integer: The dimension of the signing session page when it is opened in percents. - `preview-button` object: Configuration of the Open Preview button in the toolbar. Available for embedded sending and embedded editor. - `visibility` boolean: Whether to show the Open Preview button in the toolbar. - `complete-footer` object - `visibility` boolean: Whether the footer about completion of all the required fields should be visible or not. - `custom-text` object - `en` string: Footer text in English. - `es` string: Footer text in Spanish. - `fr` string: Footer text in French. - `continue-button` object: Configuration of the Continue button. Available for embedded sending. - `visibility` boolean: Whether to show the Continue button in the header. - `download-button` object: An object that defines the download options for the recipient. - `visibility` boolean: Defines the visibility of the **Download** and **History** buttons during the signing session and **Download**, **Download With History** and **Document History** buttons in view mode. - `request-payment` object: Configuration of the request payment option in the editor. Available for embedded sending and embedded editor. - `visibility` boolean: Whether to show the Payment Request option in the settings dropdown. - `signing-settings` object: Settings configured for the signing experience. - `guide-signers-only-through-required-fields` boolean: Whether to guide signers through required fields only. `true` - the **Go Through Required Fields** checkbox is checked in **More Actions**; the signer will be guided only through required fields; `false` – the **Go Through Required Fields** checkbox is not checked in **More Actions**; the signer will be guided through all fields. - `auto-apply-signatures-and-initials-to-document-fields` boolean: Whether to offer a signer to automatically apply signature and initials to all corresponding empty fields in a document after filling out the first field. `true` – the signer will be prompted to automatically fill all empty signature and initials fields after completing the first one; `false` – the signer will need to fill each signature and initials field individually; no prompt will be shown. - `manage-recipients` object: Configuration of the Manage Recipients link. Available for embedded sending and embedded editor. - `visibility` boolean: Whether to show the Manage Recipients link. - `step-progress-bar` object: Configuration of the steps progress bar. Available for embedded sending and embedded editor. - `visibility` boolean: Whether to show the steps progress bar in the header. - `thumbnails-button` object: Configuration of the Thumbnails button in the toolbar. Available for embedded sending and embedded editor. - `visibility` boolean: Whether to show the Thumbnails button in the toolbar. - `decline-invite-text` object: Custom message in the pop-up that appears when a signer clicks the **Decline** button. The signer needs to confirm declining the document. - `en` string: Custom welcome message in English that can be updated. Placeholders {invite_owner_email} and {document_name} are available. - `es` string: Custom welcome message in Spanish that can be updated. Placeholders {invite_owner_email} and {document_name} are available. - `fr` string: Custom welcome message in French that can be updated. Placeholders {invite_owner_email} and {document_name} are available. ## Response `204` Success, no content - object ## Other responses - `400`: * Incorrect or missing token. * Request body is incorrect or missing. * `settings` is not an array. * `settings.visibility` is not a boolean. * `decline-invite-text` is not an array. * `decline-invite-text.en` is not a string. * `accessibility` is not an array. * `accessibility.visibility` is not a boolean. * `color` value is not a string. * `background` is not a string. * `border` is not a string. * `active-color` is not a string. * `active-background` is not a string. * `active-border` is not a string. * `hover-color` is not a string. * `hover-background` is not a string. * `hover-border` is not a string. * `enabled` is not a boolean. * `navigation` is not an array. * `navigation.visibility` is not a boolean. * `progress-bar` is not an array. * `default-color` is not a string. * `completed-color` is not a string. * `sidebar` is not an array. * `sidebar.background` is not a string. * `sidebar.visibility` is not a boolean. * `complete-footer` field is not an array. * `complete-footer.visibility` is not a boolean. * `complete-footer.custom-text` is not an array. * `complete-footer.custom-text.en` is not a string. * `support-chat` is not an array. * `support-chat.visibility` is not a boolean. * `complete-page.success` is not an array. * `complete-page.success.header-text.en` not a string. * `complete-page.success.body-text.en` not a string. * `complete-page.decline` is not an array. * `complete-page.decline.header-text.en` is not a string. * `complete-page.decline.body-text.en` is not a string. * `registration` is not an array. * `registration.visibility` is not a boolean. * `button-to-signnow` is not an array. * `button-to-signnow.visibility` is not a boolean. * `button-download` is not an array. * `button-download.visibility` is not a boolean. * `sender-info` is not an array. * `sender-info.visibility` is not a boolean. * `page-dimension` is not an array. * `percent` is not an integer. * `contact-name` is not a string. * `contact-email` is not a string. * `close-button` is not an array. * `close-button.visibility` is not a boolean. * `close-button.title` not array. * `close-button.title.signing` is not an array. * `close-button.title.editor` is not an array. * `close-button.title.signing.en` is not a string. * `close-button.title.signing.fr` is not a string. * `close-button.title.signing.es` is not a string. * `close-button.title.editor.en` is not a string. * `close-button.title.editor.fr` is not a string. * `close-button.title.editor.es` is not a string. * `close-button.title.signing.en` is too long. * `close-button.title.signing.fr` is too long. * `close-button.title.signing.es` is too long. * `close-button.title.editor.en` is too long. * `close-button.title.editor.fr` is too long. * `close-button.title.editor.es` is too long. * `close-button.title.signing.en` contains UTF 4-byte characters. * `close-button.title.signing.fr` contains UTF 4-byte characters. * `close-button.title.signing.es` contains UTF 4-byte characters. * `close-button.title.editor.en` contains UTF 4-byte characters. * `close-button.title.editor.fr` contains UTF 4-byte characters. * `close-button.title.editor.es` contains UTF 4-byte characters. * `decline-button` is not an array. * `decline-button.visibility` is not a boolean. * `document-name` is not an array. * `document-name.visibility` is not a boolean. * `toolbar` is not an array. * `toolbar.visibility` is not a boolean. * `toolbar.background` not a string. * `toolbar.background` has incorrect format. * `editing-tools` is not an array. * `editing-tools.background` is not a string. * `editing-tools.background` has incorrect format. * `manage-recipients` is not an array. * `manage-recipients.visibility` is not a boolean. * `preview-button` is not an array. * `preview-button.visibility` is not a boolean. * `thumbnails-button` is not an array. * `thumbnails-button.visibility` is not a boolean. * `request-payment` is not an array. * `request-payment.visibility` is not a boolean. * `continue-button` is not an array. * `continue-button.visibility` is not a boolean. * `step-progress-bar` is not an array. * `step-progress-bar.visibility` is not a boolean. * `signing-settings` type is incorrect. * `signing-settings.guide-signers-only-through-required-fields` type is incorrect. * 'signing-settings.auto-apply-signatures-and-initials-to-document-fields` type is incorrect. * `fields` is not an array. * `fields.signature` is not an array. * `fields.signature.visibility` is not a boolean. * `fields.text` is not an array. * `fields.text.visibility` is not a boolean. * `fields.date` is not an array. * `fields.date.visibility` is not a boolean. * `fields.initials` is not an array. * `fields.initials.visibility` is not a boolean. * `fields.fullname` is not an array. * `fields.fullname.visibility` is not a boolean. * `fields.email` is not an array. * `fields.email.visibility` is not a boolean. * `fields.checkbox` is not an array. * `fields.checkbox.visibility` is not a boolean. * `fields.radiobutton` is not an array. * `fields.radiobutton.visibility` is not a boolean. * `fields.attachment` is not an array. * `fields.attachment.visibility` is not a boolean. * `fields.dropdown` is not an array. * `fields.dropdown.visibility` is not a boolean. * `fields.stamp` is not an array. * `fields.stamp.visibility` is not a boolean. * `fields.formula` is not an array. * `fields.formula.visibility` is not a boolean. * `fields.hyperlink` is not an array. * `fields.hyperlink.visibility` is not a boolean. * `field-settings` is not an array. * `field-settings.visibility` is not a boolean. * `default-fields` is not an array. * `default-fields.visibility` is not a boolean. - `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)