Advertisers

Advertisers are the brands on your platform that would like to purchase OOH.

list advertisers

get

Header parameters

X-PARTNER-TOKENstringOptional

Responses

200

successful

application/json

get

/v1/advertisers

HTTPcURLJavaScriptPython

GET /v1/advertisers HTTP/1.1
Host: api.adquick.com
Accept: */*

200

successful

{
  "records": [
    {
      "id": 1,
      "name": "text",
      "website": "text",
      "brand": null
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1,
    "total_entries": 1
  }
}

create advertiser

post

Header parameters

X-PARTNER-TOKENstringOptional

Body

application/json

namestring · min: 1Required

websitestring · min: 1Required

brandstring · nullableOptional

Responses

200

successful

application/json

idnotRequired

namestring · min: 1Required

websitestring · min: 1Required

brandstring · nullableOptional

post

/v1/advertisers

HTTPcURLJavaScriptPython

POST /v1/advertisers HTTP/1.1
Host: api.adquick.com
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "website": "text",
  "brand": null
}

200

successful

{
  "id": 1,
  "name": "text",
  "website": "text",
  "brand": null
}

show advertiser

get

Path parameters

idstringRequired

Header parameters

X-PARTNER-TOKENstringOptional

Responses

200

successful

application/json

idnotRequired

namestring · min: 1Required

websitestring · min: 1Required

brandstring · nullableOptional

get

/v1/advertisers/{id}

HTTPcURLJavaScriptPython

GET /v1/advertisers/{id} HTTP/1.1
Host: api.adquick.com
Accept: */*

200

successful

{
  "id": 1,
  "name": "text",
  "website": "text",
  "brand": null
}

update advertiser

patch

Path parameters

idstringRequired

Header parameters

X-PARTNER-TOKENstringOptional

Body

application/json

namestring · min: 1Optional

websitestring · min: 1Optional

brandstring · nullableOptional

Responses

201

successful

application/json

patch

/v1/advertisers/{id}

HTTPcURLJavaScriptPython

PATCH /v1/advertisers/{id} HTTP/1.1
Host: api.adquick.com
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "website": "text",
  "brand": null
}

201

successful

{
  "id": 1,
  "name": "text",
  "website": "text",
  "brand": null
}

Endpoints

Summary

POST /advertisers #=> Create advertiser
GET /advertisers #=>  List advertisers
GET /advertisers/:id #=> Get specific advertiser
PATCH /advertisers/:id #=> Edit advertiser

Create Advertiser

POST /advertisers

Expects:
- name
- website
- brand (optional)

Returns:
- id
- name
- website

Important note: You should save the returned id to the advertiser on your end – it's needed for other requests.

List Advertisers

GET /advertisers
Returns: paginated array of advertiser objects inside a "records" key

Get Advertiser

GET /advertisers/:id
Returns:
{
  "records": [
    {
      "id": 1,
      "name": "First Advertiser",
      "website": "www.first.com",
      "brand": null
    },
    {
      "id": 2,
      "name": "Second Advertiser",
      "website": "www.second.com",
      "brand": null
    }
  ],
  "pagination": {
    "current_page": 2,
    "next_page": null,
    "prev_page": 1,
    "total_pages": 2,
    "total_entries": 4
  }
}

Edit Advertiser

PATCH /advertisers/:id
Expects: any combination of name, website, and/or brand

Returns:
- id