Digito

Actualizar un sobre

Actualiza las propiedades y la configuración de un sobre.

POST /envelope/update

URL base: https://business.digito.do/api/v2.

Ejemplos

Configura DIGITO_API_TOKEN en el servidor. Sustituye los IDs y archivos de ejemplo por los de tu equipo. TypeScript usa fetch y FormData de Node.js.

curl --fail-with-body \
  --request POST \
  --url 'https://business.digito.do/api/v2/envelope/update' \
  --header "Authorization: $DIGITO_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "envelopeId": "sobre_de_ejemplo",
  "data": {
    "title": "Contrato de servicios actualizado",
    "externalId": "contrato-2026-001"
  },
  "meta": {
    "language": "es",
    "envelopeExpirationPeriod": {
      "unit": "day",
      "amount": 14
    }
  }
}
JSON

Antes de empezar

  • Las opciones de autenticación y de representación visible que admite el contrato no reemplazan las reglas de firma de Digito. La expiración y los recordatorios se configuran dentro de meta.

Autenticación

Envía el token de la API en el encabezado Authorization. El acceso corresponde al equipo y a los permisos del token. Conserva el token en tu servidor.

Authorization: api_TU_TOKEN

Antes de cada acción de firma, el firmante debe autenticarse de nuevo con Digito ID. Una sesión previa de Business, un token de destinatario o un token de la API no sustituye este requisito.

Parámetros

Esta operación no declara parámetros de ruta ni de consulta.

Cuerpo de la solicitud

El cuerpo es obligatorio.

Tipo de contenido: application/json.

Objeto de ejemplo

{
  "envelopeId": "sobre_de_ejemplo",
  "data": {
    "title": "Contrato de servicios actualizado",
    "externalId": "contrato-2026-001"
  },
  "meta": {
    "language": "es",
    "envelopeExpirationPeriod": {
      "unit": "day",
      "amount": 14
    }
  }
}

Los valores muestran una solicitud posible; no son valores predeterminados del servidor.

PropiedadTipoObligatoriaRestricciones
envelopeIdstringSíSin restricciones adicionales en este nivel.
dataobjectNoSin restricciones adicionales en este nivel.
metaobjectNoSin restricciones adicionales en este nivel.
Ver el esquema completo de la solicitud
{
  "type": "object",
  "properties": {
    "envelopeId": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "externalId": {
          "type": "string",
          "nullable": true,
          "maxLength": 255
        },
        "visibility": {
          "type": "string",
          "enum": [
            "EVERYONE",
            "MANAGER_AND_ABOVE",
            "ADMIN"
          ]
        },
        "globalAccessAuth": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "ACCOUNT",
              "TWO_FACTOR_AUTH"
            ]
          }
        },
        "globalActionAuth": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "ACCOUNT",
              "PASSKEY",
              "TWO_FACTOR_AUTH",
              "PASSWORD"
            ]
          }
        },
        "folderId": {
          "type": "string",
          "nullable": true
        },
        "templateType": {
          "type": "string",
          "enum": [
            "PUBLIC",
            "PRIVATE",
            "ORGANISATION"
          ]
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "subject": {
          "type": "string",
          "maxLength": 254
        },
        "message": {
          "type": "string",
          "maxLength": 5000
        },
        "timezone": {
          "type": "string"
        },
        "dateFormat": {
          "type": "string",
          "enum": [
            "yyyy-MM-dd hh:mm a",
            "yyyy-MM-dd",
            "dd/MM/yyyy",
            "dd-MM-yyyy",
            "MM/dd/yyyy",
            "yy-MM-dd",
            "MMMM dd, yyyy",
            "EEEE, MMMM dd, yyyy",
            "dd/MM/yyyy hh:mm a",
            "dd/MM/yyyy HH:mm",
            "dd-MM-yyyy hh:mm a",
            "dd-MM-yyyy HH:mm",
            "MM/dd/yyyy hh:mm a",
            "MM/dd/yyyy HH:mm",
            "dd.MM.yyyy",
            "dd.MM.yyyy HH:mm",
            "yyyy-MM-dd HH:mm",
            "yy-MM-dd hh:mm a",
            "yy-MM-dd HH:mm",
            "yyyy-MM-dd HH:mm:ss",
            "MMMM dd, yyyy hh:mm a",
            "MMMM dd, yyyy HH:mm",
            "EEEE, MMMM dd, yyyy hh:mm a",
            "EEEE, MMMM dd, yyyy HH:mm",
            "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
          ]
        },
        "distributionMethod": {
          "type": "string",
          "enum": [
            "EMAIL",
            "NONE"
          ]
        },
        "signingOrder": {
          "type": "string",
          "enum": [
            "PARALLEL",
            "SEQUENTIAL"
          ]
        },
        "allowDictateNextSigner": {
          "type": "boolean"
        },
        "redirectUrl": {
          "type": "string"
        },
        "language": {
          "type": "string",
          "enum": [
            "en",
            "es"
          ]
        },
        "typedSignatureEnabled": {
          "type": "boolean"
        },
        "uploadSignatureEnabled": {
          "type": "boolean"
        },
        "drawSignatureEnabled": {
          "type": "boolean"
        },
        "emailId": {
          "type": "string",
          "nullable": true
        },
        "emailReplyTo": {
          "type": "string",
          "nullable": true,
          "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$"
        },
        "emailSettings": {
          "type": "object",
          "nullable": true,
          "properties": {
            "recipientSigningRequest": {
              "type": "boolean",
              "default": true
            },
            "recipientRemoved": {
              "type": "boolean",
              "default": true
            },
            "recipientSigned": {
              "type": "boolean",
              "default": true
            },
            "documentPending": {
              "type": "boolean",
              "default": true
            },
            "documentCompleted": {
              "type": "boolean",
              "default": true
            },
            "documentDeleted": {
              "type": "boolean",
              "default": true
            },
            "ownerDocumentCompleted": {
              "type": "boolean",
              "default": true
            },
            "ownerRecipientExpired": {
              "type": "boolean",
              "default": true
            },
            "ownerDocumentCreated": {
              "type": "boolean",
              "default": true
            }
          },
          "default": {
            "recipientSigningRequest": true,
            "recipientRemoved": true,
            "recipientSigned": true,
            "documentPending": true,
            "documentCompleted": true,
            "documentDeleted": true,
            "ownerDocumentCompleted": true,
            "ownerRecipientExpired": true,
            "ownerDocumentCreated": true
          }
        },
        "envelopeExpirationPeriod": {
          "nullable": true,
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "unit": {
                  "type": "string",
                  "enum": [
                    "day",
                    "week",
                    "month",
                    "year"
                  ]
                },
                "amount": {
                  "type": "integer",
                  "minimum": 1
                }
              },
              "required": [
                "unit",
                "amount"
              ]
            },
            {
              "type": "object",
              "properties": {
                "disabled": {
                  "type": "boolean",
                  "enum": [
                    true
                  ]
                }
              },
              "required": [
                "disabled"
              ]
            }
          ]
        },
        "reminderSettings": {
          "type": "object",
          "nullable": true,
          "properties": {
            "sendAfter": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "unit": {
                      "type": "string",
                      "enum": [
                        "day",
                        "week",
                        "month"
                      ]
                    },
                    "amount": {
                      "type": "integer",
                      "minimum": 1
                    }
                  },
                  "required": [
                    "unit",
                    "amount"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "disabled": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    }
                  },
                  "required": [
                    "disabled"
                  ]
                }
              ]
            },
            "repeatEvery": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "unit": {
                      "type": "string",
                      "enum": [
                        "day",
                        "week",
                        "month"
                      ]
                    },
                    "amount": {
                      "type": "integer",
                      "minimum": 1
                    }
                  },
                  "required": [
                    "unit",
                    "amount"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "disabled": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    }
                  },
                  "required": [
                    "disabled"
                  ]
                }
              ]
            }
          },
          "required": [
            "sendAfter",
            "repeatEvery"
          ]
        }
      }
    }
  },
  "required": [
    "envelopeId"
  ]
}

Respuesta de éxito

Esta referencia muestra las propiedades documentadas para Digito. Conserva el resto de la respuesta recibida en tu aplicación.

Este objeto sintético ilustra las propiedades documentadas de una respuesta 200. Los identificadores, fechas, estados y tokens son datos de ejemplo.

{
  "internalVersion": 1,
  "type": "DOCUMENT",
  "status": "DRAFT",
  "source": "DOCUMENT",
  "visibility": "EVERYONE",
  "templateType": "PRIVATE",
  "id": "sobre_de_ejemplo",
  "secondaryId": "envelope_secundario_de_ejemplo",
  "externalId": null,
  "createdAt": "2026-10-06T12:00:00.000Z",
  "updatedAt": "2026-10-06T12:00:00.000Z",
  "completedAt": null,
  "deletedAt": null,
  "title": "Contrato de servicios actualizado",
  "authOptions": null,
  "formValues": null,
  "publicTitle": "valor_de_ejemplo",
  "publicDescription": "valor_de_ejemplo",
  "userId": 1,
  "teamId": 1,
  "folderId": null
}

Respuestas y errores

EstadoDescripciónContenido y esquema
200Respuesta correcta.application/json
400Datos de entrada inválidos.application/json
401No se proporcionó autorización.application/json
403Permisos insuficientes.application/json
500Error interno del servidor.application/json

Los esquemas enlazados incluyen propiedades anidadas, campos obligatorios, variantes, enumeraciones, nulabilidad y restricciones. Consulta errores y reintentos para manejar respuestas no exitosas.

Identificador de operación: envelope-update.

En esta página

EjemplosAntes de empezarAutenticaciónParámetrosCuerpo de la solicitudObjeto de ejemploRespuesta de éxitoRespuestas y errores