Cadastra um novo agendamento. É necessário informar o ContatoId no corpo da requisição.

1. Requisição HTTP

POST https://www.keymessages.com.br/api/contatos/agendamentos
                

2. Cabeçalhos

3. Corpo da Requisição (JSON)

{
    "ContatoId": "GUID-do-contato",
    "Titulo": "Parabéns",
    "Mensagem": "Feliz aniversário!",
    "AgendamentoAtivo": true,
    "TipoAgendamento": 0,
    "DataUnica": "2025-12-31T10:00:00Z",
    "TerminalID": "GUID-do-terminal"
}
                

4. Resposta Exemplo

HTTP/1.1 200 OK
{
    "id": "GUID-do-agendamento"
}
                

5. Exemplo de cURL

curl --request POST \
    --url https://www.keymessages.com.br/api/contatos/agendamentos \
    --header 'Content-Type: application/json' \
    --header 'UserToken: TokenDoUsuario' \
    --data '{
    "ContatoId": "GUID-do-contato",
    "Titulo": "Parabéns",
    "Mensagem": "Feliz aniversário!",
    "AgendamentoAtivo": true,
    "TipoAgendamento": 0,
    "DataUnica": "2025-12-31T10:00:00Z",
    "TerminalID": "GUID-do-terminal"
}'
                

6. Possíveis Erros

• 401 Unauthorized
  • UserToken ausente ou vazio

    HTTP/1.1 401 Unauthorized
    {
        "mensagem": "O Token do usuario é necessário. [UserToken]"
    }
                                    

  • UserToken inválido

    HTTP/1.1 401 Unauthorized
    {
        "mensagem": "O Token do usuario é inválido. [UserToken]"
    }
                                    

  • Contato não encontrado ou não pertence ao usuário

    HTTP/1.1 401 Unauthorized
    {
        "mensagem": "Contato não encontrado ou não pertence ao usuário."
    }
                                    

• 400 Bad Request Falha na validação do corpo da requisição:
  • Body nulo

    HTTP/1.1 400 Bad Request
    {
        "mensagem": "Os dados do agendamento são necessários. [Body]"
    }
                                    

  • Titulo em branco ou nulo

    HTTP/1.1 400 Bad Request
    {
        "mensagem": "O título é necessário. [Titulo]"
    }
                                    

  • TerminalID em branco ou nulo

    HTTP/1.1 400 Bad Request
    {
        "mensagem": "O Terminal é necessário. [TerminalID]"
    }
                                    

  • Erro genérico durante o cadastro

    HTTP/1.1 400 Bad Request
    {
        "mensagem": "Descrição detalhada do erro interno"
    }
                                    

• 500 Internal Server Error

  HTTP/1.1 500 Internal Server Error
  {
      "mensagem": "Algo deu errado no servidor. Tente novamente mais tarde."
  }