Create Advertiser API

The Create Advertiser API is used to create an advertiser account in the affiliate's account. If the advertiser account already exists, it will update the advertiser details.

Request URL

To access the Create Advertiser API, make a request to the following URL:

https://<JIVOX_SERVER>/jivox/serverAPIs/rest/createAdvertiser.php

The request URL supports the following parameters:

Parameter	Description
emailAddress	(Required) Email address for the advertiser account
firstName	(Required) First name of advertiser contact
lastName	(Required) Last name of advertiser contact
companyName	(Required) Company name
group	(Optional) Group under which Advertiser is to be created
site	(Optional) Site under which Advertiser is to be created
city	(Optional) Contact's address – city
state	(Optional) Contact's address – state
country	(Optional) Contact's address – country
zipCode	(Optional) Contact's address – zip code

Example

Javascript
    
curl –d 'apiId=aaa&apiKey=bbb&apiVersion=1.0&publisherId=xxx&emailAddress=foo@bar.com&firstName=foo&lastName=bar&companyName=foobar Inc' https:__<JIVOX_Server>_jivox_serverAPIs_rest_createAdvertiser.php
Copy

Server Success Response

In case of success, the server returns the following response:

Javascript
    
​x
 
<jivoxServerResponse><result>SUCCESS<_result><id>advertiserID<_id>​<_jivoxServerResponse>
Copy

Fields in the server response XML are as follows:

id: Created Advertiser ID
accountLoginURL: URL to access Advertiser Account in the Jivox System

Last updated on

Was this page helpful?