How do I upload featured and top header images via the API?

If you would like to upload a featured or top header image to a campaign via the API you will have to call a different endpoint than the one used for saving a campaign.

If you would like to POST an image you would call:

campaign/[Campaign ID]/resource/file

If you would like to PUT or DELETE an image you would call:

campaign/[Campaign ID/resource/file/[Image ID]

When uploading an image using either POST or PUT you MUST specify in the “Request Payload” the “resource_content_type” and the “region_id”.

For the featured and top header images the “resource_content_type” payload will always be “image”.

The “region_id” is where you would like the image to go. If you would like to upload a featured image then the “region_id” must be 3.

faq_1

If you would like to upload a top header image then the “region_id” must be 5.

faq_2

You should do a PUT on the image ID if the image already exists. If it doesn’t exist then do a POST.