Criar ou executar cancel

POST /api/company/v1/{company_role_id}/virtual-visit/schedule/{schedule_id}/cancel

O que este endpoint faz

Este endpoint cria, dispara ou processa a ação de cancel conforme o contrato do backend. Ele pertence ao domínio de cadastro, dados operacionais, documentos, usuários e permissões por empresa.

Use POST /api/company/v1/{company_role_id}/virtual-visit/schedule/{schedule_id}/cancel quando a integração precisar acionar esse comportamento exatamente como o app da Antecipa Fácil faz pelo gateway público. A rota depende de company_role_id, schedule_id, então a chamada deve ser feita no contexto correto da empresa, título ou recurso informado.

Para que serve

Ele ajuda a compor fluxos de integração do backend do parceiro com a plataforma, mantendo autenticação via Bearer token e tráfego pelo APIM. Consulte os parâmetros, corpo de requisição e respostas desta página antes de usar em produção.

Parâmetros

company_role_id path obrigatório

Valor usado para compor a chamada deste endpoint.

schedule_id path obrigatório

Valor usado para compor a chamada deste endpoint.

Respostas

201 Operação executada com sucesso.

Try it POST

URL Bearer token

Clique em Try it! para executar a chamada pelo navegador.

Exemplos

curl --request POST \
  --url 'https://api.antecipafacil.net.br/api/company/v1/123/virtual-visit/schedule/123/cancel' \
  --header 'accept: application/json' \
  --header 'Authorization: Bearer <access_token>'

const response = await fetch('https://api.antecipafacil.net.br/api/company/v1/123/virtual-visit/schedule/123/cancel', {
  method: 'POST',
  headers: {
    accept: 'application/json',
    Authorization: 'Bearer <access_token>',
  },
});

const data = await response.json();
console.log(data);

const response = await fetch('https://api.antecipafacil.net.br/api/company/v1/123/virtual-visit/schedule/123/cancel', {
  method: 'POST',
  headers: {
    accept: 'application/json',
    Authorization: 'Bearer <access_token>',
  },
});

console.log(await response.json());

import requests

url = "https://api.antecipafacil.net.br/api/company/v1/123/virtual-visit/schedule/123/cancel"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer <access_token>",
}

response = requests.post(url, headers=headers)
response.raise_for_status()
print(response.json())

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.antecipafacil.net.br/api/company/v1/123/virtual-visit/schedule/123/cancel");
request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<access_token>");

using var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

let client = reqwest::Client::new();
let response = client
    .request(reqwest::Method::POST, "https://api.antecipafacil.net.br/api/company/v1/123/virtual-visit/schedule/123/cancel")
    .bearer_auth("<access_token>")
    .header("accept", "application/json")
    .send()
    .await?;

let body = response.text().await?;
println!("{}", body);