Banner

Update banner configuration

Partially updates the banner configuration for a site.

patch/sites/{id}/banner

Request

  • Base URL: http://localhost:3001/api/v1
  • URL: http://localhost:3001/api/v1/sites/{id}/banner
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Site ID

Example:550e8400-e29b-41d4-a716-446655440000

Request body

template'floating' | 'wide_bar' | 'modal'
position'bottom_left' | 'bottom_right' | 'top_left' | 'top_right' | 'bottom' | 'top' | 'center'
textTranslationsobject
privacyPolicyUrlstring uri nullable
cookiePolicyUrlstring uri nullable
defaultBehavior'opt_in' | 'opt_out' | 'no_banner'
closeButtonBehavior'accept_all' | 'reject_all' | 'dismiss'
cookieExpirationDaysinteger

Response

Updated banner configuration

idstring uuid required
siteIdstring uuid required
template'floating' | 'wide_bar' | 'modal' required
position'bottom_left' | 'bottom_right' | 'top_left' | 'top_right' | 'bottom' | 'top' | 'center' required
colorsobject required
textOverridesobject required
logoUrlstring nullable required
privacyPolicyUrlstring nullable required
defaultBehavior'opt_in' | 'opt_out' | 'no_banner' required
closeButtonBehavior'accept_all' | 'reject_all' | 'dismiss' required
cookieExpirationDaysnumber required
consentVersionnumber required
blockingRulesunknown
gcmExcludeGoogleboolean required
shopifyIntegrationboolean required
createdAtstring required
updatedAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.