Skip to main content
PUT
Update advertiser

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.

Path Parameters

id
integer
required

Advertiser ID.

Body

application/json
email
string<email>

Advertiser email address.

password
string

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

password_repeat
string

Password confirmation.

company_name
string

Advertiser 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

Advertiser account status (Identity): 1=active, 2=pending, 3=inactive.

api_status
integer

API access: 1=enabled, 2=disabled.

country
integer

Country geoname_id.

region
string

Region/state name.

Maximum string length: 128
city
string

City name.

Maximum string length: 128
address
string

Street address.

Maximum string length: 128
postal_code
string

Postal or ZIP code.

Maximum string length: 16
timezone
string

IANA timezone identifier.

Maximum string length: 64
number_format_id
integer

Number format preference ID.

date_format_id
integer

Date format preference ID.

contacts
string

JSON string with contact information.

notes
string

Public 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
Maximum string length: 64

Response

Updated advertiser.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object