Upload a file to the media library

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/upload.do

Stores a video, an image (JPG, PNG, GIF, WebP or SVG) or an HTML5 banner ZIP once, so any number of creatives can use it: a Local Video or Advanced Local Video(s) creative takes a video, a Local File creative an image, and a template creative's HTML5 ZIP property a ZIP — pass the file's id as 'mediaAssetId' when creating or updating the creative. The type is read from the file's content, not its name. Videos follow the network's video size limit and images its image limit; a ZIP follows the HTML5 archive limits. Videos are read with ffprobe, and a file that cannot be read is refused. When an identical file (same MD5) is already in the library and visible to the user, nothing is stored again: that file is returned with 'duplicate' true. 'advertiserId' labels the file for filtering; a user with shared advertisers must send one of theirs. Requires the MEDIA_LIBRARY permission and update rights on campaigns (on that advertiser when one is sent).

Query Params

advertiserId integer

Advertiser the file is for; a filter label

1001

name string

Display name; the file name when empty

Spring sale 30s

Body

A multipart form: file (file).

Responses

200

{success, duplicate, asset:{...}}

400

Field errors under 'errors': 'file' missing, unsupported, unreadable or too large; 'advertiserId' required

401

Authentication error

403

The role lacks MEDIA_LIBRARY or campaign update rights, or no rights on the advertiser

404

The advertiser does not exist or is deleted

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/upload.do?advertiserId=1001&name=Spring%20sale%2030s' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --form 'file=@video.mp4'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/upload.do?advertiserId=1001&name=Spring%20sale%2030s", headers={"X-Api-Key": "YOUR_API_KEY"}, files={"file": open("video.mp4", "rb")})
print(response.json())

Node Request

import fs from 'node:fs/promises';

const form = new FormData();
form.append('file', new Blob([await fs.readFile('video.mp4')]), 'video.mp4');

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/upload.do?advertiserId=1001&name=Spring%20sale%2030s', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
  body: form,
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/upload.do?advertiserId=1001&name=Spring%20sale%2030s"))
    .header("X-Api-Key", "YOUR_API_KEY")
    // multipart upload: build the body with your HTTP library of choice
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/upload.do?advertiserId=1001&name=Spring%20sale%2030s");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
var form = new MultipartFormDataContent();
form.Add(new ByteArrayContent(File.ReadAllBytes("video.mp4")), "file", "video.mp4");
request.Content = form;

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/upload.do?advertiserId=1001&name=Spring%20sale%2030s", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	// multipart upload: build the body with mime/multipart

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/upload.do?advertiserId=1001&name=Spring%20sale%2030s");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, ["file" => new CURLFile("video.mp4")]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/upload.do?advertiserId=1001&name=Spring%20sale%2030s")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request.set_form([['file', File.open('video.mp4')]], 'multipart/form-data')

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body