/

Browse the help center

Create a user and share advertisers or sites with them

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/system-users/create-and-share.do

The console's 'Create user & share' in one call: creates an active account with the given 'login' (its username), e-mail and role, owned by the caller, and optionally shares advertisers and sites with it at 'shareType' (default CAN_VIEW). No password is sent or returned: the new user receives the console's invitation e-mail with a single-use link to choose one — the advertiser statistics-account invitation when advertisers are shared (naming the first), the site one when only sites are, otherwise the network's account-activated e-mail. 'role' is a role id or name and must be one the caller's role may create users in; an administrator role is never accepted. A role that cannot see advertisers (or sites) cannot receive them. Each shared advertiser needs campaign SHARE (SHARED or ALL) and edit rights on it, each site inventory SHARE and edit rights on it; with SHARE at SHARED level your own share on it must be higher than 'shareType' (IS_OWNER > CAN_EDIT > CAN_VIEW). Nothing is created unless every check passes. Login and e-mail must be unused. The field is 'login' rather than 'username' because 'username' is the authentication parameter of /rest-api.

Form Params

email string required

E-mail address, unused so far; the invitation goes here

reports@northwind.example

login string required

Username the new account signs in with, unused so far, up to 64 characters

northwind.reports

role string required

Role id or name (case-insensitive). Must be a role your role may create users in; never an administrator role.

Statistics Account for Advertiser

advertiserIds array<integer>

Advertisers to share with the new user

1001

firstName string

Optional first name

Mara

lastName string

Optional last name

Whitfield

shareType string

Access the shares give: CAN_VIEW (default), CAN_EDIT or IS_OWNER

CAN_VIEW

siteIds array<integer>

Sites to share with the new user

2001

Responses

200

User created: {success, userId, username, email, roleId, role, active, shareType, advertiserIds, siteIds, invitationSentTo}

400

Field errors under 'errors' (login, email, role), including a login or e-mail already in use, or an unknown role (the message lists the roles you may assign)

401

Authentication error

403

The role may not be assigned by the caller, or a share is not allowed

404

An advertiser or site does not exist, is deleted or is not visible to the caller

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/system-users/create-and-share.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'email=reports@northwind.example' \
  --data-urlencode 'login=northwind.reports' \
  --data-urlencode 'role=Statistics Account for Advertiser' \
  --data-urlencode 'advertiserIds=1001' \
  --data-urlencode 'firstName=Mara' \
  --data-urlencode 'lastName=Whitfield'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/system-users/create-and-share.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"email": "reports@northwind.example", "login": "northwind.reports", "role": "Statistics Account for Advertiser", "advertiserIds": "1001", "firstName": "Mara", "lastName": "Whitfield"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/system-users/create-and-share.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"email":"reports@northwind.example","login":"northwind.reports","role":"Statistics Account for Advertiser","advertiserIds":"1001","firstName":"Mara","lastName":"Whitfield"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/system-users/create-and-share.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("email=reports%40northwind.example&login=northwind.reports&role=Statistics%20Account%20for%20Advertiser&advertiserIds=1001&firstName=Mara&lastName=Whitfield"))
    .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/system-users/create-and-share.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["email"] = "reports@northwind.example", ["login"] = "northwind.reports", ["role"] = "Statistics Account for Advertiser", ["advertiserIds"] = "1001", ["firstName"] = "Mara", ["lastName"] = "Whitfield" });

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/system-users/create-and-share.do", strings.NewReader(`email=reports%40northwind.example&login=northwind.reports&role=Statistics%20Account%20for%20Advertiser&advertiserIds=1001&firstName=Mara&lastName=Whitfield`))
	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/system-users/create-and-share.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, 'email=reports%40northwind.example&login=northwind.reports&role=Statistics%20Account%20for%20Advertiser&advertiserIds=1001&firstName=Mara&lastName=Whitfield');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/system-users/create-and-share.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('email' => "reports@northwind.example", 'login' => "northwind.reports", 'role' => "Statistics Account for Advertiser", 'advertiserIds' => "1001", 'firstName' => "Mara", 'lastName' => "Whitfield")

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