MadHive modify advertiser API
The modify advertiser API from MadHive — 1 operation(s) for modify advertiser.
OpenAPI Specification
openapi: 3.2.0
info:
title: Madhive modify advertiser API
version: 1.0.0
description: "The Madhive API provides a comprehensive interface for digital advertising clients and services.\n\n## Authentication\nThis API uses OAuth 2.0 client credentials flow for authentication. To access protected endpoints:\n\n1. **Obtain an access token** using the `/oauth/token` endpoint with your client credentials\n2. **Include the token** in subsequent API requests using the `Authorization` header:\n ```\n Authorization: Bearer YOUR_ACCESS_TOKEN_HERE\n ```\n\n### Token Usage Example\n```bash\n# Get access token\ncurl -X POST \"https://api2.madhive.com/oauth/token\" \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -d \"grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET\"\n\n# Use token in API requests\ncurl -H \"Authorization: Bearer YOUR_ACCESS_TOKEN_HERE\" \\\n \"https://api2.madhive.com/v1/campaigns\"\n```\n\n**Note:** Access tokens have an expiration time. You should handle token refresh in your application logic.\n"
servers:
- url: https://api2.madhive.com/api
description: apigee
tags:
- name: modify advertiser
paths:
/v1/advertisers/{id}:
put:
tags:
- modify advertiser
summary: Ability to update an advertiser including Advertiser Name, Advertiser Domain, IAB Category, Associated Agency, and External ID. Receives back the updated Advertiser.
description: Ability to update an advertiser including Advertiser Name, Advertiser Domain, IAB Category, Associated Agency, and External ID. Receives back the updated Advertiser.
operationId: updateAdvertiser
parameters:
- $ref: '#/components/parameters/PathID'
- $ref: '#/components/parameters/X-Cloud-Trace-Context'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdvertiserRequest'
description: advertiser update
required: true
responses:
'200':
description: advertiser updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/AdvertiserResponse'
examples:
response:
value:
id: KHKRwqM4728ZD3qNBSG0IrxSZb8L
customerExternalId: adv-KHKRwqM4728ZD3qNBSG0IrxSZb8L
name: Madhive
domain: madhive.com
associatedAgency: fake agency
iabCategory: IAB1
status: DRAFT
transaction:
id: 4af459ff8e1a36b6bb74fb88f1a02477
created: '2030-11-02T15:04:00Z'
'400':
$ref: '#/components/responses/400InvalidID'
'401':
$ref: '#/components/responses/401Unauthorized'
security:
- oauth2: []
components:
responses:
400InvalidID:
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
$ref: '#/components/examples/400InvalidID'
401Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
$ref: '#/components/examples/401Ex'
schemas:
Advertiser:
type: object
required:
- name
- domain
- iabCategory
- status
properties:
id:
type: string
x-go-type-skip-optional-pointer: true
x-oapi-codegen-extra-tags:
validate: required_with=Status,omitempty,min=28,max=28
description: madhive advertiser id
example: 4gV9KIg6E2kX3d6117OO8rgseJRl
customerExternalId:
type: string
x-go-type-skip-optional-pointer: true
x-oapi-codegen-extra-tags:
validate: 'omitempty,min=2,ne= '
x-omitempty: true
description: external id of the advertiser
example: adv-123456
name:
type: string
x-oapi-codegen-extra-tags:
validate: 'required,min=2,ne= '
x-isnullable: false
x-omitempty: false
description: advertiser name
example: Madhive
domain:
type: string
x-oapi-codegen-extra-tags:
validate: required,url_badformat,url_invalidprefix,url_denylist,url_notexist
x-omitempty: false
x-isnullable: false
description: advertiser domain
example: madhive.com
iabCategory:
type: string
x-oapi-codegen-extra-tags:
validate: 'required,min=2,ne= '
x-omitempty: false
x-isnullable: false
description: iab category
example: IAB1
associatedAgency:
type: string
x-go-type-skip-optional-pointer: true
x-oapi-codegen-extra-tags:
validate: 'omitempty,min=2,ne= '
x-omitempty: true
description: advertiser's associated agency
example: fake agency name
status:
$ref: '#/components/schemas/Status'
ErrorResponse:
type: object
required:
- transaction
properties:
errors:
type: array
x-go-type-skip-optional-pointer: true
items:
type: string
description: many error messages
error:
type: string
x-go-type-skip-optional-pointer: true
description: error message
example: Unauthorized
status:
type: string
x-go-type-skip-optional-pointer: true
description: status of the service
example: ERROR
transaction:
$ref: '#/components/schemas/Transaction'
AdvertiserRequest:
type: object
required:
- name
- domain
- iabCategory
properties:
customerExternalId:
type: string
x-go-type-skip-optional-pointer: true
x-oapi-codegen-extra-tags:
validate: 'omitempty,min=2,ne= '
x-omitempty: true
description: external id of the advertiser
example: adv-123456
name:
type: string
x-oapi-codegen-extra-tags:
validate: 'required,min=2,ne= '
x-isnullable: false
x-omitempty: false
description: advertiser name
example: Madhive
domain:
type: string
x-oapi-codegen-extra-tags:
validate: required
x-omitempty: false
x-isnullable: false
description: advertiser domain
example: madhive.com
iabCategory:
type: string
x-oapi-codegen-extra-tags:
validate: 'required,min=2,ne= '
x-omitempty: false
x-isnullable: false
description: iab category
example: IAB1
associatedAgency:
type: string
x-go-type-skip-optional-pointer: true
x-oapi-codegen-extra-tags:
validate: 'omitempty,min=2,ne= '
x-omitempty: true
description: advertiser's associated agency
example: fake agency name
Transaction:
type: object
x-go-type-skip-optional-pointer: true
x-omitempty: false
required:
- id
- taskId
- created
properties:
id:
type: string
description: trace id
example: 4af459ff8e1a36b6bb74fb88f1a02477
taskId:
type: string
x-omitempty: true
description: task id
example: '14158884487309867565'
created:
type: string
description: 'order created date, format: yyyy-mm-dd hh:mm:ss'
example: '2030-11-02T15:04:00Z'
AdvertiserResponse:
type: object
allOf:
- $ref: '#/components/schemas/Advertiser'
- type: object
required:
- transaction
properties:
transaction:
$ref: '#/components/schemas/Transaction'
Status:
type: string
x-isnullable: false
x-omitempty: false
x-oapi-codegen-extra-tags:
validate: omitempty,oneof=READY ARCHIVED CANCELLED DRAFT PAUSED
description: status of the entity
example: READY
enum:
- READY
- ARCHIVED
- CANCELLED
- DRAFT
- PAUSED
parameters:
X-Cloud-Trace-Context:
name: X-Cloud-Trace-Context
in: header
description: gcp trace
required: false
schema:
type: string
default: 91f9f012dc7c7ffc13604c77f12a8931
PathID:
name: id
in: path
description: resource id
required: true
schema:
type: string
x-oapi-codegen-extra-tags:
validate: required,min=28,max=28
examples:
401Ex:
value:
error: unauthorized
status: ERROR
transaction:
id: 4af459ff8e1a36b6bb74fb88f1a02477
taskId: '14158884487309867565'
created: '2030-11-02T15:04:00Z'
400InvalidID:
value:
error: invalid resource id
status: ERROR
transaction:
id: 4af459ff8e1a36b6bb74fb88f1a02477
taskId: '14158884487309867565'
created: '2030-11-02T15:04:00Z'
securitySchemes:
oauth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api2.madhive.com/oauth/token
scopes: {}
basicAuth:
type: http
description: Basic Authentication Not Implemented
scheme: basic
bearerAuth:
type: apiKey
name: Authorization
in: header
description: jwt access token for authentication