Unified.to ads API

openapi: 3.0.0
info:
  contact:
    email: hello@unified.to
    url: https://unified.to/contact
  description: One API to Rule Them All
  termsOfService: https://unified.to/tos
  title: Unified.to account ads API
  version: '1.0'
servers:
- description: North American data region
  url: https://api.unified.to
- description: European data region
  url: https://api-eu.unified.to
- description: Australian data region
  url: https://api-au.unified.to
security:
- jwt: []
tags:
- name: ads
paths:
  /ads/{connection_id}/ad:
    get:
      operationId: listAdsAds
      parameters:
      - in: query
        name: limit
        required: false
        schema:
          type: number
      - in: query
        name: offset
        required: false
        schema:
          type: number
      - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
        in: query
        name: updated_gte
        required: false
        schema:
          type: string
      - in: query
        name: sort
        required: false
        schema:
          type: string
      - in: query
        name: order
        required: false
        schema:
          type: string
      - description: Query string to search. eg. email address or name
        in: query
        name: query
        required: false
        schema:
          type: string
      - description: The org ID to filter by (reference to AdsOrganization)
        in: query
        name: org_id
        required: false
        schema:
          type: string
      - description: The campaign ID to filter by
        in: query
        name: campaign_id
        required: false
        schema:
          type: string
      - description: The group ID to filter by (reference to AdsGroup)
        in: query
        name: group_id
        required: false
        schema:
          type: string
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - campaign_id
            - group_id
            - organization_id
            - status
            - ad_type
            - creative_ids
            - creative_asset_url
            - ad_copy
            - headline
            - description
            - cta
            - final_url
            - display_url
            - path1
            - path2
            - promoted
            - raw
            type: string
          type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsAds'
          description: Successful
      security:
      - jwt: []
      summary: List All Ads
      tags:
      - ads
    post:
      operationId: createAdsAd
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - campaign_id
            - group_id
            - organization_id
            - status
            - ad_type
            - creative_ids
            - creative_asset_url
            - ad_copy
            - headline
            - description
            - cta
            - final_url
            - display_url
            - path1
            - path2
            - promoted
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdsAd'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsAd'
          description: Successful
      security:
      - jwt: []
      summary: Create an Ad
      tags:
      - ads
  /ads/{connection_id}/ad/{id}:
    delete:
      operationId: removeAdsAd
      parameters:
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Ad
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful
        default:
          content: {}
          description: Successful
          headers:
            Content-Type:
              required: false
              schema:
                type: string
      security:
      - jwt: []
      summary: Remove an Ad
      tags:
      - ads
    get:
      operationId: getAdsAd
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - campaign_id
            - group_id
            - organization_id
            - status
            - ad_type
            - creative_ids
            - creative_asset_url
            - ad_copy
            - headline
            - description
            - cta
            - final_url
            - display_url
            - path1
            - path2
            - promoted
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Ad
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsAd'
          description: Successful
      security:
      - jwt: []
      summary: Retrieve an Ad
      tags:
      - ads
    patch:
      operationId: patchAdsAd
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - campaign_id
            - group_id
            - organization_id
            - status
            - ad_type
            - creative_ids
            - creative_asset_url
            - ad_copy
            - headline
            - description
            - cta
            - final_url
            - display_url
            - path1
            - path2
            - promoted
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Ad
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdsAd'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsAd'
          description: Successful
      security:
      - jwt: []
      summary: Update an Ad
      tags:
      - ads
    put:
      operationId: updateAdsAd
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - campaign_id
            - group_id
            - organization_id
            - status
            - ad_type
            - creative_ids
            - creative_asset_url
            - ad_copy
            - headline
            - description
            - cta
            - final_url
            - display_url
            - path1
            - path2
            - promoted
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Ad
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdsAd'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsAd'
          description: Successful
      security:
      - jwt: []
      summary: Update an Ad
      tags:
      - ads
  /ads/{connection_id}/campaign:
    get:
      operationId: listAdsCampaigns
      parameters:
      - in: query
        name: limit
        required: false
        schema:
          type: number
      - in: query
        name: offset
        required: false
        schema:
          type: number
      - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
        in: query
        name: updated_gte
        required: false
        schema:
          type: string
      - in: query
        name: sort
        required: false
        schema:
          type: string
      - in: query
        name: order
        required: false
        schema:
          type: string
      - description: Query string to search. eg. email address or name
        in: query
        name: query
        required: false
        schema:
          type: string
      - description: The org ID to filter by (reference to AdsOrganization)
        in: query
        name: org_id
        required: false
        schema:
          type: string
      - description: The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
        in: query
        name: start_gte
        required: false
        schema:
          type: string
      - description: The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
        in: query
        name: end_lt
        required: false
        schema:
          type: string
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - organization_id
            - status
            - start_at
            - end_at
            - budget_amount
            - budget_period
            - total_spend_amount
            - targeting
            - goal
            - planned_spend_amount
            - frequency_cap
            - advertising_channel_type
            - campaign_budget_identifier
            - currency
            - category
            - has_eu_political_ads
            - raw
            type: string
          type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsCampaigns'
          description: Successful
      security:
      - jwt: []
      summary: List All Campaigns
      tags:
      - ads
    post:
      operationId: createAdsCampaign
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - organization_id
            - status
            - start_at
            - end_at
            - budget_amount
            - budget_period
            - total_spend_amount
            - targeting
            - goal
            - planned_spend_amount
            - frequency_cap
            - advertising_channel_type
            - campaign_budget_identifier
            - currency
            - category
            - has_eu_political_ads
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdsCampaign'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsCampaign'
          description: Successful
      security:
      - jwt: []
      summary: Create a Campaign
      tags:
      - ads
  /ads/{connection_id}/campaign/{id}:
    delete:
      operationId: removeAdsCampaign
      parameters:
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Campaign
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful
        default:
          content: {}
          description: Successful
          headers:
            Content-Type:
              required: false
              schema:
                type: string
      security:
      - jwt: []
      summary: Remove a Campaign
      tags:
      - ads
    get:
      operationId: getAdsCampaign
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - organization_id
            - status
            - start_at
            - end_at
            - budget_amount
            - budget_period
            - total_spend_amount
            - targeting
            - goal
            - planned_spend_amount
            - frequency_cap
            - advertising_channel_type
            - campaign_budget_identifier
            - currency
            - category
            - has_eu_political_ads
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Campaign
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsCampaign'
          description: Successful
      security:
      - jwt: []
      summary: Retrieve a Campaign
      tags:
      - ads
    patch:
      operationId: patchAdsCampaign
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - organization_id
            - status
            - start_at
            - end_at
            - budget_amount
            - budget_period
            - total_spend_amount
            - targeting
            - goal
            - planned_spend_amount
            - frequency_cap
            - advertising_channel_type
            - campaign_budget_identifier
            - currency
            - category
            - has_eu_political_ads
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Campaign
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdsCampaign'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsCampaign'
          description: Successful
      security:
      - jwt: []
      summary: Update a Campaign
      tags:
      - ads
    put:
      operationId: updateAdsCampaign
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - organization_id
            - status
            - start_at
            - end_at
            - budget_amount
            - budget_period
            - total_spend_amount
            - targeting
            - goal
            - planned_spend_amount
            - frequency_cap
            - advertising_channel_type
            - campaign_budget_identifier
            - currency
            - category
            - has_eu_political_ads
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Campaign
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdsCampaign'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsCampaign'
          description: Successful
      security:
      - jwt: []
      summary: Update a Campaign
      tags:
      - ads
  /ads/{connection_id}/creative:
    get:
      operationId: listAdsCreatives
      parameters:
      - in: query
        name: limit
        required: false
        schema:
          type: number
      - in: query
        name: offset
        required: false
        schema:
          type: number
      - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
        in: query
        name: updated_gte
        required: false
        schema:
          type: string
      - in: query
        name: sort
        required: false
        schema:
          type: string
      - in: query
        name: order
        required: false
        schema:
          type: string
      - description: Query string to search. eg. email address or name
        in: query
        name: query
        required: false
        schema:
          type: string
      - description: The org ID to filter by (reference to AdsOrganization)
        in: query
        name: org_id
        required: false
        schema:
          type: string
      - description: The group ID to filter by (reference to AdsGroup)
        in: query
        name: group_id
        required: false
        schema:
          type: string
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - campaign_id
            - group_id
            - item_id
            - organization_id
            - status
            - creative_type
            - hosting_source
            - width
            - height
            - asset_urls
            - link_url
            - body
            - title
            - cta
            - third_party_tag
            - vast_tag_url
            - external_creative_reference
            - external_placement_reference
            - external_ad_reference
            - promoted
            - path1
            - path2
            - raw
            type: string
          type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsCreatives'
          description: Successful
      security:
      - jwt: []
      summary: List All Creatives
      tags:
      - ads
    post:
      operationId: createAdsCreative
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - campaign_id
            - group_id
            - item_id
            - organization_id
            - status
            - creative_type
            - hosting_source
            - width
            - height
            - asset_urls
            - link_url
            - body
            - title
            - cta
            - third_party_tag
            - vast_tag_url
            - external_creative_reference
            - external_placement_reference
            - external_ad_reference
            - promoted
            - path1
            - path2
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdsCreative'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsCreative'
          description: Successful
      security:
      - jwt: []
      summary: Create a Creative
      tags:
      - ads
  /ads/{connection_id}/creative/{id}:
    delete:
      operationId: removeAdsCreative
      parameters:
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Creative
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful
        default:
          content: {}
          description: Successful
          headers:
            Content-Type:
              required: false
              schema:
                type: string
      security:
      - jwt: []
      summary: Remove a Creative
      tags:
      - ads
    get:
      operationId: getAdsCreative
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - campaign_id
            - group_id
            - item_id
            - organization_id
            - status
            - creative_type
            - hosting_source
            - width
            - height
            - asset_urls
            - link_url
            - body
            - title
            - cta
            - third_party_tag
            - vast_tag_url
            - external_creative_reference
            - external_placement_reference
            - external_ad_reference
            - promoted
            - path1
            - path2
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Creative
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsCreative'
          description: Successful
      security:
      - jwt: []
      summary: Retrieve a Creative
      tags:
      - ads
    patch:
      operationId: patchAdsCreative
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - campaign_id
            - group_id
            - item_id
            - organization_id
            - status
            - creative_type
            - hosting_source
            - width
            - height
            - asset_urls
            - link_url
            - body
            - title
            - cta
            - third_party_tag
            - vast_tag_url
            - external_creative_reference
            - external_placement_reference
            - external_ad_reference
            - promoted
            - path1
            - path2
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Creative
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdsCreative'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsCreative'
          description: Successful
      security:
      - jwt: []
      summary: Update a Creative
      tags:
      - ads
    put:
      operationId: updateAdsCreative
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - campaign_id
            - group_id
            - item_id
            - organization_id
            - status
            - creative_type
            - hosting_source
            - width
            - height
            - asset_urls
            - link_url
            - body
            - title
            - cta
            - third_party_tag
            - vast_tag_url
            - external_creative_reference
            - external_placement_reference
            - external_ad_reference
            - promoted
            - path1
            - path2
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Creative
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdsCreative'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdsCreative'
          description: Successful
      security:
      - jwt: []
      summary: Update a Creative
      tags:
      - ads
  /ads/{connection_id}/group:
    get:
      operationId: listAdsGroups
      parameters:
      - in: query
        name: limit
        required: false
        schema:
          type: number
      - in: query
        name: offset
        required: false
        schema:
          type: num

# --- truncated at 32 KB (168 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/openapi/unified-to-ads-api-openapi.yml