Pular para o conteúdo
POST/compromissos/{id}/remarcar

Remarcar compromisso

agenda:escrevermódulo Agendaaceita Idempotency-Key

Só compromissos marcados ou confirmados. Volta para marcado e dispara agendamento.remarcado. Cancelado ou encerrado devolve 409.

POST /compromissos/{id}/remarcar

curl -X POST "https://chat.forsi.com.br/api/v1/compromissos/e0c6d7e8-baef-444c-acaf-8ea96e737165/remarcar" \
  -H "Authorization: Bearer $FORSI_CHAVE" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: pedido-4821" \
  -d '{"inicio":"2026-10-13T09:30:00-03:00"}'
Resposta 200
{
  "dados": {
    "id": "e0c6d7e8-baef-444c-acaf-8ea96e737165",
    "agenda_id": "f7233bb7-10b6-49d2-aa3b-8c2e7d88064d",
    "agenda": "Dra. Ana Lima",
    "cor": "blue",
    "titulo": "Consulta de retorno",
    "inicio": "2026-10-12T17:00:00.000Z",
    "fim": "2026-10-12T17:30:00.000Z",
    "fuso": "America/Sao_Paulo",
    "inicio_local": "2026-10-12T14:00:00-03:00",
    "fim_local": "2026-10-12T14:30:00-03:00",
    "duracao_min": 30,
    "estado": "marcado",
    "local": "Rua das Flores, 120 - sala 4",
    "link": "https://meet.google.com/abc-defg-hij",
    "notas": "Trazer os exames.",
    "contato_id": "08054a7f-a752-481e-9915-cf4cf944df39",
    "conversa_id": "495a7cae-128c-4b66-adbc-807b3959c129",
    "contato": {
      "id": "08054a7f-a752-481e-9915-cf4cf944df39",
      "nome": "Maria Souza",
      "telefone": "+5531988887777",
      "avatar_url": "https://chat.forsi.com.br/avatar.png"
    },
    "lembretes": [
      {
        "antes_min": 1440,
        "estado": "texto",
        "enviar_em": "2026-10-04T13:05:12.481Z",
        "enviado_em": "2026-10-04T13:05:12.481Z"
      }
    ],
    "criado_por_tipo": "texto",
    "criado_em": "2026-10-04T13:05:12.481Z",
    "confirmado_em": "2026-10-04T13:05:12.481Z",
    "cancelado_em": "2026-10-04T13:05:12.481Z"
  }
}

Parâmetros no caminho#

  • iduuidobrigatório

    No caminho da URL.

Corpo da requisição#

JSON. Mande com Content-Type: application/json.

  • iniciodata e hora ISO 8601obrigatório

    Novo começo (com fuso).

  • fimdata e hora ISO 8601opcional

    Novo fim (com fuso).

  • duracao_minintegeropcional

    Duração em minutos (5 a 720).

  • agenda_iduuidopcional

    Mudar de agenda junto com o horário.

Resposta#

200 com {"dados": ...}: Compromisso.

  • iduuidopcional
    —
  • agenda_iduuidopcional
    —
  • agendastringopcional
    —
  • corstringopcional
    —
  • titulostringopcional
    —
  • iniciodata e hora ISO 8601opcional
    —
  • fimdata e hora ISO 8601opcional
    —
  • fusostringopcional
    —
  • inicio_localstringopcional

    Começo no fuso da agenda, com deslocamento.

    • ex.: 2026-10-12T14:00:00-03:00
  • fim_localstringopcional

    Fim no fuso da agenda, com deslocamento.

    • ex.: 2026-10-12T14:00:00-03:00
  • duracao_minintegeropcional
    —
  • estado"marcado" | "confirmado" | "concluido" | "faltou" | "cancelado"opcional
    —
  • localstringopcional
    —
  • linkstringopcional
    —
  • notasstringopcional
    —
  • contato_iduuidopcional
    —
  • conversa_iduuidopcional
    —
  • contatoobjectopcional
    —
  • contato.iduuidopcional
    —
  • contato.nomestringopcional
    —
  • contato.telefonestringopcional
    —
  • contato.avatar_urlstringopcional
    —
  • lembreteslista de objectopcional
    —
  • lembretes[].antes_minintegeropcional
    —
  • lembretes[].estadostringopcional
    —
  • lembretes[].enviar_emdata e hora ISO 8601opcional
    —
  • lembretes[].enviado_emdata e hora ISO 8601opcional
    —
  • criado_por_tipostringopcional
    —
  • criado_emdata e hora ISO 8601opcional
    —
  • confirmado_emdata e hora ISO 8601opcional
    —
  • cancelado_emdata e hora ISO 8601opcional
    —

Erros#

Todo erro vem como {"erro": {"codigo", "mensagem"}}. Trate pelo codigo: ele não muda.

Status de erro desta operação
StatusQuando
401Chave ausente ou inválida (resposta igual para qualquer motivo).
403Plano sem API, escopo insuficiente ou https/origem recusados.
404Não existe nesta organização.
409Conflito (repetido, Idempotency-Key com outro corpo).
422Dados inválidos ou regra de negócio (ex.: janela_fechada; conta_restrita = a Meta restringiu a conta por spam: erro traz os campos de RestricaoMeta, como ate, escopo, motivo e retry_after_s).
429Limite de requisições. Veja Retry-After.
Códigos de erro que esta área pode devolver28
  • horario_invalidoData e hora inválidas. Use o formato 2026-10-12T14:00:00-03:00 (sempre com o fuso), com o fim depois do início.
  • janela_grandeA janela de consulta passa do máximo (62 dias).
  • duracao_invalidaDuração inválida: de 5 a 720 minutos (compromisso de até 12 horas).
  • campo_longoUm dos textos passa do tamanho máximo. O campo vem em "detalhe".
  • campo_invalidoCampo obrigatório ou inválido. O campo vem em "detalhe".
  • link_invalidoO link precisa começar com https://.
  • contato_ambiguoInforme só um entre contato_id, conversa_id e telefone.
  • conversa_de_outro_contatoA conversa informada é de outro contato.
  • evento_canceladoO compromisso está cancelado e não pode ser alterado. Marque um novo.
  • evento_finalizadoO compromisso já foi encerrado (concluído ou faltou) e não pode ser alterado.
  • horario_ocupadoEsse horário já está ocupado nessa agenda.
  • horario_bloqueadoEsse horário está bloqueado (folga, almoço ou feriado).
  • fora_do_horarioEsse horário está fora do horário de trabalho da agenda.
  • antecedenciaEsse horário está mais perto do que a antecedência mínima da agenda.
  • compromisso_estado_invalidoestado só pode ser concluido ou faltou. Para confirmar ou cancelar, use as rotas próprias.
  • nada_para_atualizarMande ao menos um campo para atualizar.
  • fuso_invalidoFuso inválido. Use um nome IANA, como America/Sao_Paulo.
  • cor_invalidaCor inválida. Use slate, blue, violet, amber, emerald, green, rose, cyan ou orange.
  • lembretes_invalidosLembretes inválidos: até 5 itens, cada um só com antes_min (1 a 43200).
  • usuario_inexistenteusuario_id não é de uma pessoa desta equipe.
  • agenda_inexistenteAgenda não encontrada (ou inativa, para marcar compromisso).
  • evento_inexistenteCompromisso não encontrado.
  • bloqueio_inexistenteBloqueio não encontrado.
  • agenda_repetidaEssa pessoa já tem uma agenda.
  • limite_agendasLimite de 100 agendas por organização.
  • limite_bloqueiosLimite de 500 bloqueios por organização.
  • bloqueio_tipo_invalidotipo deve ser folga, almoco, feriado ou outro.
  • repeticao_invalidarepetir deve ser nunca, diario, semanal ou anual; repetir_ate só vale com repetição.

Os erros que valem para qualquer rota (chave, limite, JSON) estão em Erros.