Agendamento de Upload de Documentos (API)
Este endpoint da API D4Sign permite que você agende o envio de um documento para os signatários, definindo uma data e hora específicas. Isso é super útil para organizar o fluxo de trabalho e garantir que os documentos sejam enviados no momento certo.
🚧 Importante: Não esqueça de enviar o tokenAPI e cryptKey em sua requisição.
Exemplo de URL completa para requisição: https://secure.d4sign.com.br/api/v1/documents/{uuid-document}/scheduling?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}
Header
O cabeçalho da sua requisição deve conter o Content-Type
como application/json
, além dos seus tokens de autenticação.
JSON
{
"Content-Type": "application/json",
"tokenAPI": "{SEU-TOKEN-API}",
"cryptKey": "{SUA-CRYPT-KEY}"
}
Body
No corpo da requisição, você informará os detalhes do agendamento, como a data, a hora e as configurações do fluxo de assinatura.
JSON
{
"message":"Mensagem opcional de envio",
"workflow":"1",
"scheduling_date":"2026/09/10",
"scheduling_time":"21:00",
"urgent_document":"0"
}
Detalhes dos Parâmetros do Body:
Parâmetro | Tipo | Obrigatoriedade | Descrição |
uuid-document |
String | Obrigatório | O UUID (identificador único) do documento principal que você deseja agendar o envio. |
message |
String | Opcional | Uma mensagem personalizada que será enviada junto com o documento para os signatários. |
workflow |
String | Obrigatório | Define a ordem de assinaturas: 1 para não seguir a ordem de assinaturas (envio simultâneo) e 2 para seguir a ordem predefinida de assinaturas. |
scheduling_date |
String | Obrigatório | A data de agendamento para o envio. Deve ser igual ou posterior à data atual e estar no formato americano (AAAA/MM/DD). |
scheduling_time |
String | Obrigatório | O horário de agendamento para o envio. Deve estar sempre entre 6:00 e 22:00 e ser em intervalos de uma hora (ex: 11:00, 12:00, 13:00, etc.). Se a data de agendamento for o dia atual, o horário agendado precisa ser posterior ao horário atual. |
urgent_document |
String | Opcional | Indica se o documento é urgente: 0 para não é um documento urgente e 1 para é um documento urgente. |
Resposta (Status 200 - Sucesso)
Quando a requisição for bem-sucedida, você receberá uma mensagem de confirmação do agendamento.
JSON
{
"message": "Scheduling created successfully",
"mensagem_pt": "Agendamento criado com sucesso."
}