← InícioFleetPay / API

Disparar nova rodada de ofertas aos motoristas elegíveis

Parâmetros, estrutura de dados e respostas do contrato versionado.

POST/gestor/programacoes-ofertas/{id}/disparar-rodada
dispararRodadaProgramacaoGestorBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Executa uma rodada de distribuição para vagas em aberto da programação, respeitando elegibilidade e limite de exposição. Dispara webhook oferta.rodada_disparada. Exige escopo operacao.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Gestor de Transporte e Alocação
Perfis Aplicáveis
Gestor de Transporte
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

idpath · integerObrigatório

ID numérico da programação de ofertas.

Restrições
{
  "type": "integer"
}

Corpo da Requisição

Opcional

Parâmetros opcionais da rodada.

application/json

Respostas

200 Resposta HTTP

Operação processada com sucesso.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"homologacao" · "producao"
401 Resposta HTTP

Credencial ausente, inválida ou de outro ambiente.

403 Resposta HTTP

Escopo do painel não habilitado ou recurso fora do escopo da company.

404 Resposta HTTP

Programação não encontrada.

Definição Completa da Operação
{
  "tags": [
    "Programações & Alocação"
  ],
  "operationId": "dispararRodadaProgramacaoGestor",
  "summary": "Disparar nova rodada de ofertas aos motoristas elegíveis",
  "description": "Executa uma rodada de distribuição para vagas em aberto da programação, respeitando elegibilidade e limite de exposição. Dispara webhook `oferta.rodada_disparada`. Exige escopo `operacao`.",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "ID numérico da programação de ofertas.",
      "schema": {
        "type": "integer"
      }
    }
  ],
  "requestBody": {
    "required": false,
    "description": "Parâmetros opcionais da rodada.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": true
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Operação processada com sucesso.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                ]
              },
              "meta": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": true
              },
              "ambiente": {
                "type": "string",
                "enum": [
                  "homologacao",
                  "producao"
                ]
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Credencial ausente, inválida ou de outro ambiente."
    },
    "403": {
      "description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
    },
    "404": {
      "description": "Programação não encontrada."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "gestor-alocacao",
  "x-fleetpay-profiles": [
    "gestor"
  ],
  "method": "POST",
  "path": "/gestor/programacoes-ofertas/{id}/disparar-rodada"
}