Define Promotion Low Demand Time Rule

curl --request PUT \ --url https://api.example.com/api/v1/ops/promotions/{promotionalId}/low-demand-time-rule \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "weekdays": [ 123 ], "startTime": "<string>", "endTime": "<string>", "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "maxOccupancyRateBps": 123 } '

{ "promotionalLowDemandTimeRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "promotionalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "weekdays": [ 123 ], "startTime": "<string>", "endTime": "<string>", "maxOccupancyRateBps": 123, "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z", "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "deletedAt": "2023-11-07T05:31:56Z" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

promotionalId

string<uuid>

required

Promotion identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

Query Parameters

fields

string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Define promotion low demand time rule payload

weekdays

integer[]

required

Dias da semana aceitos, de 0 a 6

startTime

string

required

Horário inicial aceito no formato HH:mm

endTime

string

required

Horário final aceito no formato HH:mm

applyTo

enum<string>

required

Nível em que o desconto é aplicado

Available options:

ORDER,

TICKET

routeId

string<uuid> | null

Rota exigida, quando a regra é restrita a uma rota

maxOccupancyRateBps

integer | null

Ocupação máxima permitida em basis points

Response

Regra fixa de promoção para horários de menor demanda

promotionalLowDemandTimeRuleId

string<uuid>

required

Identificador único

promotionalId

string<uuid>

required

Promoção dona da regra

organizationId

string<uuid>

required

Organização da Company responsável pela promoção

companyId

string<uuid>

required

Company dona da promoção

routeId

string<uuid> | null

required

Rota exigida, quando a regra é restrita a uma rota

weekdays

integer[]

required

Dias da semana aceitos, de 0 a 6

startTime

string

required

Horário inicial aceito no formato HH:mm

endTime

string

required

Horário final aceito no formato HH:mm

maxOccupancyRateBps

integer | null

required

Ocupação máxima permitida em basis points

applyTo

enum<string>

required

Nível em que o desconto é aplicado

Available options:

ORDER,

TICKET

createdBy

string<uuid> | null

required

Usuário que criou o registro, quando aplicável

createdAt

string<date-time>

required

Data de criação

updatedBy

string<uuid> | null

required

Usuário que fez a última atualização, quando aplicável

updatedAt

string<date-time>

required

Data da última atualização

deletedBy

string<uuid> | null

required

Usuário que removeu o registro, quando aplicável

deletedAt

string<date-time> | null

required

Data de remoção lógica