Advertisers API

Advertisers are a central component to the Convertr data structure. Campaigns must be linked to an Advertiser and subsequently Leads are linked to a Campaign.

Listing Advertisers:

GET /api/v4/advertisers

Response:

{
    "@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"
            },
            "address": {
                "@id": "/api/v4/addresses/331",
                "@type": "Address",
                "type": null,
                "building": "Convertr",
                "line2": null,
                "line3": null,
                "town": "London",
                "postcode": "EC1M 4NH",
                "notes": null,
                "country": "/api/v4/countries/1"
            }
            ...

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:

POST /api/v4/advertisers
{
    "name": "Test Advertiser",
    "accountManager": "",
    "campaignManager": null,
    "firstName": "Test Advertiser",
    "lastName": "Test Advertiser",
    "email": "testadvertiser@convertr.io",
    "telephone": "0202020220",
    "orgurl": "CONVERTR MEDIA LIMITED",
    "autosignContract": false,
    "notes": "",
    "useIoManagement": false,
    "address": {
        "building": "Test Advertiser",
        "town": "Test Advertiser",
        "postcode": "Test Advertiser",
        "country": "/api/v4/countries/1"
    }
}

Property	Type	Notes
`name`	string	Must be unique
`campaignManager`	IRI string	IRI from `/api/v4/users` endpoint filtered by e.g `"campaignManager":"/api/v4/users/123"`
`accountManager`	string
`firstName`	string
`lastName`	string
`email`	string
`telephone`	string
`orgurl`	string
`autosignContract`	boolean	If enabled, new campaigns will not need to be approved.
`notes`	string
`useIoManagement`	boolean	Recommended to be false.
`address`	object
`address.building`	string
`address.town`	string
`address.postcode`	string
`address.country`	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:

{
    "@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