Update Promotion - Documentação DEVMOB

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

Update promotion payload

name

string

Nome interno da promoção

description

string | null

Descrição interna da campanha

displayTitle

string

Título exibido para o cliente no catálogo

displayDescription

string | null

Texto curto exibido para o cliente antes do checkout

callToActionLabel

string | null

Texto do CTA exibido no front

discountType

enum<string>

Forma de cálculo do desconto

Available options:

PERCENTAGE,

FIXED_AMOUNT

discountValue

integer

Valor do desconto em centavos ou basis points, conforme discountType

maxDiscountAmount

integer | null

Teto de desconto em centavos, quando aplicável

allowedChannels

string[]

Canais onde a promoção pode aparecer ou ser aplicada

stackable

boolean

Indica se pode combinar com outros descontos

priority

integer

Prioridade de exibição e desempate

startsAt

string<date-time> | null

Início da validade da promoção

endsAt

string<date-time> | null

Fim da validade da promoção

status

enum<string>

Status da promoção

Available options:

DRAFT,

ACTIVE,

INACTIVE,

EXPIRED

Response

Promoção de uma Company para catálogo, descoberta e validação no checkout

promotionalId

string<uuid>

required

Identificador único

organizationId

string<uuid>

required

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

companyId

string<uuid>

required

Company dona da promoção

code

string

required

Código legível único da promoção

name

string

required

Nome interno da promoção

description

string | null

required

Descrição interna da campanha

displayTitle

string

required

Título exibido para o cliente no catálogo

displayDescription

string | null

required

Texto curto exibido para o cliente antes do checkout

callToActionLabel

string | null

required

Texto do CTA exibido no front

type

enum<string>

required

Tipo fixo da promoção

Available options:

ROUND_TRIP,

MULTI_TICKET,

ROUTE,

LOW_DEMAND_TIME

discountType

enum<string>

required

Forma de cálculo do desconto

Available options:

PERCENTAGE,

FIXED_AMOUNT

discountValue

integer

required

Valor do desconto em centavos ou basis points, conforme discountType

maxDiscountAmount

integer | null

required

Teto de desconto em centavos, quando aplicável

allowedChannels

string[]

required

Canais onde a promoção pode aparecer ou ser aplicada

stackable

boolean

required

Indica se pode combinar com outros descontos

priority

integer

required

Prioridade de exibição e desempate

startsAt

string<date-time> | null

required

Início da validade da promoção

endsAt

string<date-time> | null

required

Fim da validade da promoção

status

enum<string>

required

Status da promoção

Available options:

DRAFT,

ACTIVE,

INACTIVE,

EXPIRED

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