Create a banner

post

https://megsapp-nova-stg.85.group/api/v1/banners

Access: Auth methods: JWT bearer. Allowed user types: MVNO. Requires permissions: banner:write.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

isGlobal

boolean

required

Defaults to false

If true, banner is shown to all app users (MVNO-only).

scopePartnerId

string

Branch or leaf the banner is scoped to (required for non-global by MVNO; for partner it is set from the JWT).

imageGcsPath

string

required

GCS "folder" path (no leading slash; usually banners from upload).

imageGcsFilename

string

required

Object file name in that folder (from upload, usually a UUID + ext).

linkType

string

enum

required

Defaults to none

Allowed:

universalLinkId

string

UUID of a universal link row

externalUrl

string

External target URL

externalOpenMode

string

enum

Allowed:

sortOrder

number

Defaults to 0

Omit on create; default 0. Set when reordering in admin.

isActive

boolean

Defaults to true

Omit on create; new banners are active. Use PATCH to deactivate.

startDate

string

endDate

string

Response

201

Banner created

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here!