> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ipbox.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# cancelarAgendamento

> <h2>Cancela o agendamento especificado.</h2>

<h6 class="label label-success">Response:</h6>
<table class="table table-hover"> <tbody><tr><td>id</td><td>Id do agendamento</td></tr> <tr><td>remover_prospect</td><td>Boleano onde 1 indica que era para remover o prospect e 0 não</td></tr> </tbody></table>



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/cancelarAgendamento
openapi: 3.0.0
info:
  title: IPBoX Api Documentation v1.1
  description: >-
    Nesse documento são descritos os comandos presentes na API Rest do IPBoX. Os
    comandos são executados com chamadas POST e com respostas em formato JSON.
  version: 1.0.0
servers:
  - url: https://{baseUrl}
    description: Dominio (e porta, se houver) do servidor IPBoX do cliente
    variables:
      baseUrl:
        default: cliente.ipboxcloud.com.br:9052
        description: >-
          Substitua pelo dominio real do seu servidor IPBoX. A maioria dos
          servidores usa uma porta especifica - inclua-a junto ao dominio (ex.:
          cliente.ipboxcloud.com.br:9052)
security:
  - ApiToken: []
tags:
  - name: Agente
  - name: Ligações
  - name: Prospects
  - name: Agendamentos
  - name: Listas
  - name: Filas
  - name: Lotes
  - name: Relatórios
  - name: Outros
  - name: Times
  - name: Blacklist
  - name: Áudios
  - name: URAs
paths:
  /ipbox/api/cancelarAgendamento:
    post:
      tags:
        - Agendamentos
      summary: cancelarAgendamento
      description: >-
        <h2>Cancela o agendamento especificado.</h2>


        <h6 class="label label-success">Response:</h6>

        <table class="table table-hover"> <tbody><tr><td>id</td><td>Id do
        agendamento</td></tr> <tr><td>remover_prospect</td><td>Boleano onde 1
        indica que era para remover o prospect e 0 não</td></tr>
        </tbody></table>
      parameters:
        - name: Authorization
          in: header
          schema:
            type: string
          example: '{{token}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-www-form-urlencoded
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Id do agendamento, obtido pelo metodo getAgendamentos.
                  example: id
                remover_prospect:
                  type: string
                  description: >-
                    [Opcional] Se remover_prospect=1 remove o prospect da fila
                    de discagem, senao retorna o prospect para a fila de
                    discagem.
                  example: remover_prospect
              required:
                - id
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
components:
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo
        `Bearer ` / `Basic `.

````