# Notificar Signatários do Envelope Notificar todos os Signatários de um Envelope. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "api-v3", "version": "2.1" }, "servers": [ { "url": "https://sandbox.clicksign.com/api/v3/" } ], "components": { "securitySchemes": { "Authorization": { "type": "apiKey", "in": "header", "name": "Authorization" } } }, "security": [ { "Authorization": [] } ], "paths": { "/envelopes/{envelope_id}/notifications": { "post": { "summary": "Notificar Signatários do Envelope", "description": "Notificar todos os Signatários de um Envelope.", "operationId": "api-notificar-envelope", "parameters": [ { "name": "envelope_id", "in": "path", "description": "ID do envelope que possui o signatário", "schema": { "type": "string" }, "required": true }, { "name": "Authorization", "in": "header", "description": "Access Token gerado pelo gestor da conta", "schema": { "type": "string" }, "required": true }, { "name": "Content-type", "in": "header", "description": "Content-type padrão para todas requisições JSON:API", "schema": { "type": "string", "enum": [ "application/vnd.api+json" ], "default": "application/vnd.api+json" }, "required": true } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "default": "notifications", "enum": [ "notifications" ] }, "attributes": { "type": "object", "properties": { "message": { "type": "string", "description": "Mensagem que deve ser enviada ao signatário, se o campo não for preenchido a mensagem enviada será a configurada no `envelope#default_message`.", "default": "null", "format": "json" }, "email_customization": { "type": "object", "properties": { "subject": { "type": "string", "description": "Determina assunto do email. (Máx: 998 chars)." }, "head": { "type": "string", "description": "Determina o cabeçalho da notificação, presente no corpo do email. (Máx: 3000 chars)." }, "greeting": { "type": "string", "description": "Determina a saudação da notificação, presente no corpo do email. (Máx: 3000 chars)." }, "principal": { "type": "string", "description": "Determina a mensagem principal da notificação, presente no corpo do email. (Máx: 3000 chars)." }, "button": { "type": "string", "description": "Determina o texto no botão que direciona o signatário à assinatura. (Máx: 50 chars)." }, "final": { "type": "string", "description": "Determina a mensagem final após o botão, presente no corpo do email. (Máx: 3000 chars)." }, "align": { "type": "string", "description": "Determina o alinhamento dos elementos do email.", "enum": [ "left", "center", "right", "justify" ] }, "show_token": { "type": "boolean", "description": "Determina se o Token é exibido no corpo do email (quando existir autenticação por token)" }, "show_qrcode": { "type": "boolean", "description": "Determina se é adicionado um QR Code ao corpo do email, o conteúdo do QR Code é o link para assinatura." }, "show_details": { "type": "boolean", "description": "Determina se devem ser exibidos detalhes do processo de assinatura, impresso após todas as mensagens" } }, "description": "Determina atributos que customizam a notificação por email" } } } } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "OK": { "value": "{\n\t\"data\": {\n\t\t\"id\": \"8b7f44ac-c1c0-446e-8a5e-f1b33bd5bcce\",\n\t\t\"type\": \"notifications\",\n\t\t\"attributes\": {\n\t\t\t\"message\": \"Mensagem configurada por envelope#default_message\",\n\t\t\t\"summary\": [\n\t\t\t\t{\n\t\t\t\t\t\"signer_id\": \"cedcb6df-f935-4f6e-ad1c-1fb104c2fbc3\",\n\t\t\t\t\t\"notified\": true\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"signer_id\": \"a20f5869-d968-430a-bae1-9caac4e6c0e4\",\n\t\t\t\t\t\"notified\": true\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"created\": \"2024-03-20T11:36:50.222-03:00\"\n\t\t}\n\t}\n}" } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "example": "8b7f44ac-c1c0-446e-8a5e-f1b33bd5bcce" }, "type": { "type": "string", "example": "notifications" }, "attributes": { "type": "object", "properties": { "message": { "type": "string", "example": "Mensagem configurada por envelope#default_message" }, "summary": { "type": "array", "items": { "type": "object", "properties": { "signer_id": { "type": "string", "example": "cedcb6df-f935-4f6e-ad1c-1fb104c2fbc3" }, "notified": { "type": "boolean", "example": true, "default": true } } } }, "created": { "type": "string", "example": "2024-03-20T11:36:50.222-03:00" } } } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Not Found": { "value": "{\n\t\"errors\": [\n\t\t{\n\t\t\t\"title\": \"Registro não encontrado\",\n\t\t\t\"detail\": \"O registro identificado por bab47d5b-033c-42e1-8140-65d8b7d96231 não pôde ser encontrado\",\n\t\t\t\"code\": \"404\",\n\t\t\t\"status\": \"404\"\n\t\t}\n\t]\n}" } }, "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "example": "Registro não encontrado" }, "detail": { "type": "string", "example": "O registro identificado por bab47d5b-033c-42e1-8140-65d8b7d96231 não pôde ser encontrado" }, "code": { "type": "string", "example": "404" }, "status": { "type": "string", "example": "404" } } } } } } } } }, "503": { "description": "503", "content": { "application/json": { "examples": { "Service Unavailable": { "value": "// O erro pode estar relacionado a não ativação do envelope em sua conta.\n// Entre em contato com o suporte para ativar ajuda@clicksign.com.\n{\n\t\"errors\": [\n\t\t{\n\t\t\t\"code\": \"service_unavailable\",\n\t\t\t\"status\": 503,\n\t\t\t\"title\": \"Verificação\",\n\t\t\t\"detail\": \"Serviço indisponível\"\n\t\t}\n\t]\n}" } }, "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "example": "service_unavailable" }, "status": { "type": "integer", "example": 503, "default": 0 }, "title": { "type": "string", "example": "Verificação" }, "detail": { "type": "string", "example": "Serviço indisponível" } } } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```