Rename or relabel a media library file

Changes the display 'name' and/or the 'advertiserId' label of a file; 'advertiserId' 0 removes the label.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/{assetId}/update.do

Changes the display 'name' and/or the 'advertiserId' label of a file; 'advertiserId' 0 removes the label. The stored file never changes; a parameter not sent keeps its value. A user with shared advertisers may change only files uploaded for one of their advertisers, and may relabel them only to another of theirs, never to none. Requires the MEDIA_LIBRARY permission and update rights on campaigns.

Path Params

assetId integer required

Media library file id

42

Form Params

name string

New display name, up to 255 characters

Spring sale 30s v2

advertiserId integer

New advertiser label; 0 removes it

1001

Responses

200

{success, asset:{...}}

400

Field errors under 'errors': 'name' blank or longer than 255 characters; 'advertiserId' 0 from a user with shared advertisers

401

Authentication error

403

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

404

No such file, it is deleted, or the user cannot see it

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/42/update.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'advertiserId=1001' \
  --data-urlencode 'name=Spring sale 30s v2'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/42/update.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"advertiserId": "1001", "name": "Spring sale 30s v2"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/42/update.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"advertiserId":"1001","name":"Spring sale 30s v2"}),
});

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/42/update.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("advertiserId=1001&name=Spring%20sale%2030s%20v2"))
    .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/42/update.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["advertiserId"] = "1001", ["name"] = "Spring sale 30s v2" });

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

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/media-library/assets/42/update.do", strings.NewReader(`advertiserId=1001&name=Spring%20sale%2030s%20v2`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	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/42/update.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'advertiserId=1001&name=Spring%20sale%2030s%20v2');

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/42/update.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('advertiserId' => "1001", 'name' => "Spring sale 30s v2")

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