Versions Compared

Version Old Version 1 New Version 2
Changes made by

Danny Hannah

Danny Hannah

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
GET /api/v4/advertisers

Response:

Code Block
languagejson
{
    "@context": "/api/v4/contexts/Advertiser",
    "@id": "/api/v4/advertisers",
    "@type": "hydra:Collection",
    "hydra:member": [
        {
            "@id": "/api/v4/advertisers/22099",
            "@type": "Advertiser",
            "defaultTerms": null,
            "useIoManagement": false,
            "campaignManager": {
                "@id": "/api/v4/users/523",
                "@type": "User",
                "id": 523,
                "username": "demo user",
                "email": "demouser@convertr.io"
            },
            "accountManager": "Demo User",
            "autosignContract": false,
            "logo": null,
            "id": 22099,
            "name": "Demo Advertiser",
            "orgurl": "",
            "updatedTs": "2021-12-07T11:13:42+00:00",
            "firstName": "Demo",
            "lastName": "Demo",
            "email": "demouser@convertr.io",
            "telephone": "12345678",
            "notes": "",
            "updatedBy": {
                "@id": "/api/v4/users/506",
                "@type": "User",
                "id": 523,
                "username": "demouser",
                "email": "demouser@convertr.io"
            },
            ...

You can filter the Advertisers API endpoint with the following filters:

Property

Notes

id

Filter by specific advertiser ID

name

Partial match filter

firstName

Partial match filter

lastName

Partial match filter

email

Partial match filter

updatedTs[before|strictly_before|after|strictly_after]

Date Time searches

Creating an Advertiser:

You can create a new advertiser by posting to the /api/v4/advertisers endpoint:

...

Property

Required

Type

Notes

name

(tick)

string

Must be unique

campaignManager

(error)

IRI string

IRI from /api/v4/users endpoint, e.g
"campaignManager":"/api/v4/users/123"

accountManager

(error)

string

firstName

(tick)

string

lastName

(tick)

string

email

(tick)

string

telephone

(tick)

string

orgurl

(tick)

string

autosignContract

(tick)

boolean

If enabled, new campaigns will not need to be approved.

notes

(error)

string

useIoManagement

(tick)

boolean

Recommended to be false.

address

(tick)

object

address.building

(tick)

string

address.town

(tick)

string

address.postcode

(tick)

string

address.country

(tick)

IRI string

IRI from /api/v4/countries endpoint, e.g
"country":"/api/v4/countries/1"

Errors

Errors are returned in array format, and will return the impacted property name:

Code Block
{
    "@context": "/api/v4/contexts/ConstraintViolationList",
    "@type": "ConstraintViolationList",
    "hydra:title": "An error occurred",
    "hydra:description": "name: Advertiser with this name already exists.",
    "violations": [
        {
            "propertyPath": "name",
            "message": "Advertiser with this name already exists."
        }
    ]
}

Message

Code

Reason

Advertiser with this name already exists.

400

Advertiser name must be unique