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

# Cancelar desafio de passageiro

> Cancela um desafio de passageiro da central, com o mesmo efeito do cancelamento no painel: a contagem de corridas para, o progresso e as recompensas já creditadas ficam, e quem já tinha corrida contabilizada e ainda não tinha concluído recebe o push de desafio encerrado.

Regras importantes:
- Vale para qualquer desafio de passageiro da central, criado pela API ou pelo painel.
- Desafio já cancelado responde `200` sem disparar o push de novo. Repetir a chamada é seguro.
- Desafio já encerrado (passou de `data_hora_fim`) não é cancelado e responde `409`, como no painel: o cancelamento travaria a aprovação das recompensas personalizadas.
- Desafio inexistente ou de outra central responde `404`.

Requer Api-Key (bandeira) + autenticação HTTP Basic de um gestor ativo da bandeira, com a permissão `Gerenciar desafios` no cargo da central, como o `POST /desafios-passageiro`.



## OpenAPI

````yaml pages/v2/openapi-corridas.json DELETE /desafios-passageiro/{id}
openapi: 3.1.0
info:
  title: API de Integração
  description: API de Integração v2 - Corridas
  license:
    name: MIT
  version: 2.0.0
servers:
  - url: https://api.taximachine.com.br/api/v2/integracao
  - url: https://api-vendas.taximachine.com.br/api/v2/integracao
security:
  - basicAuth: []
    ApiKeyAuth: []
paths:
  /desafios-passageiro/{id}:
    delete:
      summary: Cancelar desafio de passageiro
      description: >-
        Cancela um desafio de passageiro da central, com o mesmo efeito do
        cancelamento no painel: a contagem de corridas para, o progresso e as
        recompensas já creditadas ficam, e quem já tinha corrida contabilizada e
        ainda não tinha concluído recebe o push de desafio encerrado.


        Regras importantes:

        - Vale para qualquer desafio de passageiro da central, criado pela API
        ou pelo painel.

        - Desafio já cancelado responde `200` sem disparar o push de novo.
        Repetir a chamada é seguro.

        - Desafio já encerrado (passou de `data_hora_fim`) não é cancelado e
        responde `409`, como no painel: o cancelamento travaria a aprovação das
        recompensas personalizadas.

        - Desafio inexistente ou de outra central responde `404`.


        Requer Api-Key (bandeira) + autenticação HTTP Basic de um gestor ativo
        da bandeira, com a permissão `Gerenciar desafios` no cargo da central,
        como o `POST /desafios-passageiro`.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            Identificador do desafio, o `id` devolvido por `POST
            /desafios-passageiro`.
          schema:
            type: integer
            example: 215
      responses:
        '200':
          description: Desafio cancelado, ou já cancelado
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
                data:
                  id: 215
                  ativo: false
        '400':
          description: >-
            Gestor sem a permissão Gerenciar desafios no cargo da central, ou
            gestor de empresa conveniada
          content:
            application/json:
              schema:
                type: object
              example:
                success: false
                errors:
                  - code: 68
                    message: >-
                      O usuário informado não tem permissão para realizar essa
                      operação.
        '401':
          description: Usuário ou senha do Basic Auth inválidos
          content:
            application/json:
              schema:
                type: object
              example:
                success: false
                errors:
                  - code: B5
                    message: Usuário e/ou senhas inválidos.
        '404':
          description: Desafio inexistente ou de outra central
          content:
            application/json:
              schema:
                type: object
              example:
                success: false
                errors:
                  - code: 243
                    message: >-
                      Desafio de passageiro não encontrado ou não pertence à
                      central autenticada.
        '409':
          description: Desafio já encerrado
          content:
            application/json:
              schema:
                type: object
              example:
                success: false
                errors:
                  - code: 244
                    message: >-
                      O desafio de passageiro já foi encerrado e não pode ser
                      cancelado.
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: Obrigatório. Sua chave API.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.