Skip to main content
POST
/
api
/
v2
/
network
/
advertisers
Create advertiser
curl --request POST \
  --url https://{domain}/api/v2/network/advertisers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "user@example.com",
  "password": "string",
  "password_repeat": "string",
  "company_name": "string",
  "firstname": "string",
  "lastname": "string"
}
'
import requests

url = "https://{domain}/api/v2/network/advertisers"

payload = {
"email": "user@example.com",
"password": "string",
"password_repeat": "string",
"company_name": "string",
"firstname": "string",
"lastname": "string"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'user@example.com',
password: 'string',
password_repeat: 'string',
company_name: 'string',
firstname: 'string',
lastname: 'string'
})
};

fetch('https://{domain}/api/v2/network/advertisers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/v2/network/advertisers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => 'user@example.com',
'password' => 'string',
'password_repeat' => 'string',
'company_name' => 'string',
'firstname' => 'string',
'lastname' => 'string'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://{domain}/api/v2/network/advertisers"

payload := strings.NewReader("{\n \"email\": \"user@example.com\",\n \"password\": \"string\",\n \"password_repeat\": \"string\",\n \"company_name\": \"string\",\n \"firstname\": \"string\",\n \"lastname\": \"string\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{domain}/api/v2/network/advertisers")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"user@example.com\",\n \"password\": \"string\",\n \"password_repeat\": \"string\",\n \"company_name\": \"string\",\n \"firstname\": \"string\",\n \"lastname\": \"string\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v2/network/advertisers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"user@example.com\",\n \"password\": \"string\",\n \"password_repeat\": \"string\",\n \"company_name\": \"string\",\n \"firstname\": \"string\",\n \"lastname\": \"string\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "code": 200,
  "name": "OK",
  "message": "<string>",
  "info": {
    "advertiser": {}
  }
}
{
"message": "Request could not be parsed.",
"success": false,
"info": {
"errors": {}
}
}
{
"message": "API key is invalid or missing.",
"success": false
}
{
"message": "This endpoint is not available for your role.",
"success": false
}
{
"message": "Validation error",
"success": false,
"info": {
"errors": {
"email": [
"Email cannot be blank."
],
"currency": [
"Currency must be a valid ISO code."
]
}
}
}
{
"message": "An unexpected error occurred.",
"success": false,
"info": {
"errors": {}
}
}

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Body

application/json
email
string<email>
required

Advertiser email (must be unique).

password
string

Login password (min 8 chars). Repeating consecutive characters are allowed.

password_repeat
string

Password confirmation (must match password).

company_name
string

Company name.

Maximum string length: 64
firstname
string

First name.

Maximum string length: 255
lastname
string

Last name.

Maximum string length: 255
phone
string

Contact phone number.

Maximum string length: 64
website_url
string

Advertiser website URL.

Maximum string length: 255
status
integer

Status: 1=active, 2=disabled, 3=pending, 4=rejected.

country
integer

Country geoname_id. Auto-detected from IP if 0.

region
string
Maximum string length: 128
city
string
Maximum string length: 128
address
string
Maximum string length: 128
postal_code
string
Maximum string length: 16
timezone
string

IANA timezone (e.g. America/New_York). Defaults to platform timezone.

Maximum string length: 64
number_format_id
integer

Number format ID.

date_format_id
integer

Date format ID.

contacts
string

JSON string with contact information.

notes
string

Notes about the advertiser.

payment_details
string

Payment details (JSON string).

tags
string

Comma-separated tag labels.

managers
string

Manager ID or comma-separated IDs to assign.

custom_fields
object

Custom field values.

image_data
string

Base64-encoded image (data:image/png;base64,...).

external_id
string

External identifier.

Maximum string length: 64
send_welcome_email
enum<integer>

Send welcome email: 1=yes, 2=no.

Available options:
1,
2
send_verification_email
enum<integer>

Send verification email: 1=yes, 2=no.

Available options:
1,
2
ip
string

IP address (used for auto-detecting country/timezone).

Response

Created advertiser.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object