Create and edit editor brand resource

This endpoint allows users to create and update an editor brand resource.

Learn more about the editor brand resource.

Note: to create an editor resource for a brand, you need to own the brand.

put/v2/brands/{brand_id}/resources/editor

Request

Path parameters

ID of the brand. Must match the pattern: [a-z0-9]{40}.

Headers

application/json

Request body

Example request

{
  "toolbar": {
    "background": "#ffffff"
  },
  "auth-page": {
    "check-pin": {
      "phone": {
        "body-text": {
          "en": "Enter the document password sent you by voice call or sms.",
          "es": "Introduce la contraseña del documento que te ha enviado por llamada de voz o sms.",
          "fr": "Entrez le mot de passe du document que vous avez reçu par appel vocal ou sms."
        }
      },
      "password": {
        "body-text": {
          "en": "Enter the document password below to unlock the document.",
          "es": "Introduce la contraseña del documento a continuación para desbloquear el documento.",
          "fr": "Entrez le mot de passe du document ci-dessous pour déverrouiller le document."
        }
      }
    },
    "header-text": {
      "en": "{sender_email} invited you to sign {document_name}",
      "es": "{sender_email} te ha invitado a firmar {document_name}",
      "fr": "{sender_email} vous a invité à signer {document_name}"
    },
    "request-pin": {
      "body-text": {
        "en": "Press the button bellow to have the password sent to you by voice call or sms message.",
        "es": "Pulsa el botón de abajo para que te envíen la contraseña por llamada de voz o mensaje sms.",
        "fr": "Appuyez sur le bouton ci-dessous pour que le mot de passe vous soit envoyé par appel vocal ou sms."
      }
    }
  },
  "close-button": {
    "title": {
      "editor": {
        "en": "Save and Close",
        "es": "Guardar y cerrar",
        "fr": "Enregistrer et fermer"
      },
      "signing": {
        "en": "Save Progress and Finish Later",
        "es": "Guardar progresos y terminar más tarde",
        "fr": "Enregistrer la progression et terminer plus tard"
      }
    }
  },
  "editing-tools": {
    "background": "#ffffff"
  },
  "default-fields": {
    "visibility": true
  },
  "field-settings": {
    "visibility": true
  }
}

Response

Success, no content

object required

Changes

No recorded changes to this operation across all 1 revision of this API.