← HomeFleetPay / API

Create offer schedule for aggregated drivers

Parameters, data structure and responses from the versioned contract.

POST/gestor/programacoes-ofertas
criarProgramacaoOfertasGestorSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Creates an offer dispatch schedule linked to an active manager negotiation and generates initial vacancies. Requires operacao scope.

Authentication

Required Scope
operacao — Operations
Module
Transport Manager & Allocation
Target Profiles
Transport Manager
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

No parameters declared for this operation.

Request Body

Required

Offer schedule configuration.

application/json

negotiation_idintegerRequired
titlestringRequired
start_datestring · dateRequired
end_datestring | null · dateOptional
daily_slotsinteger | nullOptional

Responses

201 HTTP Response

Schedule created successfully.

application/json

data—Optional
metaobject | nullOptional
additionalPropertiestrue
ambientestringOptional
"homologacao" · "producao"
401 HTTP Response

Missing, invalid or cross-environment credential.

403 HTTP Response

Dashboard scope not enabled or resource outside company scope.

422 HTTP Response

Incompatible negotiation or invalid payload.

Complete Operation Definition
{
  "tags": [
    "Programações & Alocação"
  ],
  "operationId": "criarProgramacaoOfertasGestor",
  "summary": "Criar programação de ofertas para motoristas agregados",
  "description": "Cria uma programação de disparo de ofertas vinculada a uma negociação ativa do gestor e gera vagas iniciais. Exige escopo `operacao`.",
  "requestBody": {
    "required": true,
    "description": "Configuração da programação de ofertas.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "negotiation_id",
            "title",
            "start_date"
          ],
          "properties": {
            "negotiation_id": {
              "type": "integer"
            },
            "title": {
              "type": "string"
            },
            "start_date": {
              "type": "string",
              "format": "date"
            },
            "end_date": {
              "type": [
                "string",
                "null"
              ],
              "format": "date"
            },
            "daily_slots": {
              "type": [
                "integer",
                "null"
              ]
            }
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Programação criada 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."
    },
    "422": {
      "description": "Negociação incompatível ou payload inválido."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "gestor-alocacao",
  "x-fleetpay-profiles": [
    "gestor"
  ],
  "method": "POST",
  "path": "/gestor/programacoes-ofertas",
  "parameters": []
}