v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB

Upload a campaign file - v4

This endpoint allows uploading different types of campaign files including banners, banner X, and brand pages. It includes support for hero image display modes and background positioning controls. Accepted formats include JPEG, JPG, PNG, GIF, PDF, and SVG for banners, banner X, and brand page campaigns, along with standard PDF files for content. Display logos must be in JPEG, JPG, or PNG format.

post/campaign-file-upload

Query parameters

contentStandardIdstring

The template ID that determines the type of file that can be uploaded and where it will appear in the campaign. This configuration defines accepted file formats, size limits, and display requirements.

slotIdstring

The specific location where the image will appear in the campaign template. Ensures the image adheres to predefined slot requirements and validations. Examples include left_ribbon, top_banner, or side_panel.

slotType'SLOT_TYPE_BANNER' | 'IMAGE_TYPE_DOUBLE_TILE' | 'IMAGE_TYPE_SINGLE_TILE'

Placement options for the image within the campaign include main background, secondary background, hero image, and more.

teamIdstring

The unique identifier of the campaign team.

managerTeamIdstring

Manager team ID for the campaign. Applicable only to fixed tenancy campaigns.

imageType'IMAGE_TYPE_PRIMARY_BACKGROUND' | 'IMAGE_TYPE_SECONDARY_BACKGROUND' | 'IMAGE_TYPE_PRIMARY_HERO' | 'IMAGE_TYPE_SECONDARY_HERO'

Placement options for the image within the campaign include main background, secondary background, hero image, and more.

campaignFileType'CAMPAIGN_FILE_TYPE_BANNER_IMAGE' | 'CAMPAIGN_FILE_TYPE_BANNER_X_IMAGE' | 'CAMPAIGN_FILE_TYPE_BANNER_X_CONTENT_STANDARD_DISPLAY_LOGO' | 'CAMPAIGN_FILE_TYPE_BANNER_X_CONTENT_STANDARD_PDF_FILE' | 'CAMPAIGN_FILE_TYPE_BANNER_CONTENT_STANDARD_DISPLAY_LOGO' | 'CAMPAIGN_FILE_TYPE_BANNER_CONTENT_STANDARD_PDF_FILE' | 'CAMPAIGN_FILE_TYPE_BRAND_PAGE_IMAGE' required

Specifies the campaign file type: Supported types include: -

CAMPAIGN_FILE_TYPE_BANNER_IMAGE: Image for your banner campaign. -
CAMPAIGN_FILE_TYPE_BANNER_X_IMAGE: Image for your banner X campaign. -
CAMPAIGN_FILE_TYPE_BANNER_X_CONTENT_STANDARD_DISPLAY_LOGO: Display logo for your banner X content standard file.
CAMPAIGN_FILE_TYPE_BANNER_CONTENT_STANDARD_DISPLAY_LOGO: Display logo for your banner content standard file. -
CAMPAIGN_FILE_TYPE_BANNER_X_CONTENT_STANDARD_PDF: Content standard PDF for your banner X campaign.
CAMPAIGN_FILE_TYPE_BANNER_CONTENT_STANDARD_PDF: Content standard PDF for your banner campaign.
CAMPAIGN_FILE_TYPE_BRAND_PAGE_IMAGE: Image for your BRAND PAGE campaign.

Response

File uploaded successfully

fileIdstring

The unique identifier of the uploaded file.

fileUrlstring

The URL to access the file uploaded.

Example response

{
  "fileId": "1ceee624-7c87-4e98-9995-042da2a32525",
  "fileUrl": "https://storage.googleapis.com/user_logo/.../path-to-image"
}