Soldo Online Ads API

openapi: 3.2.0
info:
  title: Soldo Business API v2.0 Online Ads API
  description: Soldo Business API v2.0 OpenAPI specification
  version: 5.56.0
servers:
- url: https://api.soldo.com
  description: Production server (using live data)
- url: https://api-demo.soldocloud.net
  description: Sandbox server (using test data)
tags:
- name: Online Ads
paths:
  /business/v2/online-ads/{onlineAdId}:
    get:
      tags:
      - Online Ads
      summary: Get Online Ads
      description: Endpoint to get a specific `OnlineAd` by ID.
      operationId: online-ads-get
      parameters:
      - name: onlineAdId
        in: path
        required: true
        schema:
          type: string
          description: The `OnlineAd` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
      responses:
        '200':
          description: The result is a single `OnlineAd`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnlineAds'
        '400':
          description: Your request has missing arguments or is malformed.
      security:
      - standardAuth:
        - online_ads_read
    put:
      tags:
      - Online Ads
      summary: Update Online Ads
      description: Endpoint to update a specific `OnlineAd`.
      operationId: online-ads-update
      parameters:
      - name: onlineAdId
        in: path
        required: true
        schema:
          type: string
          description: The `OnlineAd` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this endpoint.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOnlineAds'
      responses:
        '200':
          description: The returned resource is a single `OnlineAd`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnlineAds'
        '400':
          description: Your request has missing arguments or is malformed.
      security:
      - standardAuth:
        - online_ads_write
      x-soldo:
        fingerprint-order: id, name, wallet_id, token
    post:
      tags:
      - Online Ads
      summary: Activate Online Ads
      description: Endpoint to activate a specific `OnlineAd`.
      operationId: online-ads-activate
      parameters:
      - name: onlineAdId
        in: path
        required: true
        schema:
          type: string
          description: The `OnlineAd` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this endpoint.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.'
          example: '{{fingerprint_signature}}'
      responses:
        '200':
          description: The `Order` of the reserved `Card` for the `OnlineAd`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '400':
          description: Your request has missing arguments or is malformed.
      security:
      - standardAuth:
        - online_ads_write
      x-soldo:
        fingerprint-order: id, token
    delete:
      tags:
      - Online Ads
      summary: Delete Online Ads
      description: Endpoint to delete a specific `OnlineAd`.
      operationId: online-ads-delete
      parameters:
      - name: onlineAdId
        in: path
        required: true
        schema:
          type: string
          description: The `OnlineAd` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
      responses:
        '204':
          description: No content as result.
        '400':
          description: Your request has missing arguments or is malformed.
      security:
      - standardAuth:
        - online_ads_write
  /business/v2/online-ads/{onlineAdId}/addAssignees:
    put:
      tags:
      - Online Ads
      summary: Add assignees to Online Ads
      description: Endpoint to add assignees to an `OnlineAd`.
      operationId: online-ads-assignees-add
      parameters:
      - name: onlineAdId
        in: path
        required: true
        schema:
          type: string
          description: The `OnlineAd` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this endpoint.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddAssignees'
      responses:
        '200':
          description: The returned resource is a single `OnlineAd`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnlineAds'
        '400':
          description: Your request has missing arguments or is malformed.
      security:
      - standardAuth:
        - online_ads_write
      x-soldo:
        fingerprint-order: id, token
  /business/v2/online-ads:
    get:
      tags:
      - Online Ads
      summary: Search Online Ads
      description: Endpoint to search `OnlineAds` using filtering parameters.
      operationId: online-ads-search
      parameters:
      - name: text
        in: query
        description: A simple text to search in the `OnlineAds` data (name, description, assignee name).
        schema:
          type: string
          description: A simple text to search in the `OnlineAds` data (name, description, assignee name).
          example: onlinename
        example: onlinename
      - name: platforms
        in: query
        description: The `OnlineAds` platform.
        schema:
          type: array
          description: The `OnlineAds` platform.
          items:
            $ref: '#/components/schemas/OnlineAdsPlatform'
          uniqueItems: true
        example: GOOGLE
      - name: assignees
        in: query
        schema:
          type: array
          description: The `OnlineAds` assignees.
          example: 776f5018-07e5-426b-a426-8b23fa1e985d
          items:
            type: string
            description: The `OnlineAds` assignees.
            example: 776f5018-07e5-426b-a426-8b23fa1e985d
          uniqueItems: true
      - name: statuses
        in: query
        description: The Online Ad status.
        schema:
          type: array
          description: The Online Ad status.
          items:
            $ref: '#/components/schemas/OnlineAdsStatus'
          uniqueItems: true
        example: ACTIVE
      - name: p
        in: query
        description: It indicates the specific page to display (the counter starts from zero).
        schema:
          type: integer
          format: int32
          default: 0
          description: It indicates the specific page to display (the counter starts from zero).
          example: 3
        example: 3
      - name: s
        in: query
        description: It indicates the number of items per page.
        schema:
          type: integer
          format: int32
          default: 0
          description: It indicates the number of items per page.
          example: 25
          maximum: 50
        example: 25
      - name: d
        in: query
        description: It indicates how the pages are ordered.
        schema:
          $ref: '#/components/schemas/Direction'
        example: DESC
      - name: props
        in: query
        description: It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the `props` parameter in the request.
        schema:
          type: array
          description: It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the `props` parameter in the request.
          example: creationTime
          items:
            type: string
            description: It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the `props` parameter in the request.
            example: creationTime
        example: creationTime
      responses:
        '200':
          description: The result is an array containing `OnlineAds`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnlineAdsList'
        '400':
          description: Your request has missing arguments or is malformed.
      security:
      - standardAuth:
        - online_ads_read
    post:
      tags:
      - Online Ads
      summary: Add Online Ads
      description: Endpoint to add a new `OnlineAd`.
      operationId: online-ads-add
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this endpoint.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOnlineAds'
      responses:
        '200':
          description: The result is an `OnlineAd`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnlineAds'
        '400':
          description: Your request has missing arguments or is malformed.
      security:
      - standardAuth:
        - online_ads_write
      x-soldo:
        fingerprint-order: name, platform, wallet_id, token
  /business/v2/online-ads/{onlineAdId}/removeAssignees:
    put:
      tags:
      - Online Ads
      summary: Remove assignees from Online Ads
      description: Endpoint to remove assignees from an `OnlineAd`.
      operationId: online-ads-assignees-remove
      parameters:
      - name: onlineAdId
        in: path
        required: true
        schema:
          type: string
          description: The `OnlineAd` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveAssignees'
      responses:
        '200':
          description: The returned resource is a single `OnlineAd`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnlineAds'
        '400':
          description: Your request has missing arguments or is malformed.
      security:
      - standardAuth:
        - online_ads_write
webhooks:
  online_ads_updated:
    post:
      tags:
      - Online Ads
      summary: OnlineAds - OnlineAds Updated
      description: An `OnlineAds` has been updated.
      operationId: webhook-onlineads-online-ads-updated
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, walletId, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, walletId, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnlineAdsUpdatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, walletId, cardId
  online_ads_created:
    post:
      tags:
      - Online Ads
      summary: OnlineAds - OnlineAds Created
      description: An `OnlineAds` has been created.
      operationId: webhook-onlineads-online-ads-created
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, walletId, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, walletId, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnlineAdsCreatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, walletId, cardId
  online_ads_activated:
    post:
      tags:
      - Online Ads
      summary: OnlineAds - OnlineAds Activated
      description: An `OnlineAds` has been activated.
      operationId: webhook-onlineads-online-ads-activated
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, walletId, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, walletId, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnlineAdsActivatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, walletId, cardId
  online_ads_deleted:
    post:
      tags:
      - Online Ads
      summary: OnlineAds - OnlineAds Deleted
      description: An `OnlineAds` has been deleted.
      operationId: webhook-onlineads-online-ads-deleted
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, walletId, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, walletId, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnlineAdsDeletedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, walletId, cardId
  online_ads_assignee_added:
    post:
      tags:
      - Online Ads
      summary: OnlineAds - OnlineAds Assignee Added
      description: An `OnlineAds` assignee has been added.
      operationId: webhook-onlineads-online-ads-assignee-added
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, walletId, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, walletId, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnlineAdsAssigneeAddedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, walletId, cardId
  online_ads_assignee_removed:
    post:
      tags:
      - Online Ads
      summary: OnlineAds - OnlineAds Assignee Removed
      description: An `OnlineAds` assignee has been removed.
      operationId: webhook-onlineads-online-ads-assignee-removed
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, walletId, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, walletId, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnlineAdsAssigneeRemovedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, walletId, cardId
components:
  schemas:
    RemoveAssignees:
      description: Remove `Subscription` assignees JSON parameters.
      properties:
        remove_assignees:
          type: array
          description: List of `User` IDs to remove from assignees.
          example:
          - XMPL1234-000001
          - XMPL1234-000002
          - XMPL1234-000003
          items:
            type: string
      required:
      - remove_assignees
    OnlineAdsCreatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: OnlineAds
          description: The webhook event type.
          example: OnlineAds
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: online_ads_created
          description: The webhook event name.
          example: online_ads_created
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/OnlineAds'
          description: The webhook `OnlineAds` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    OnlineAdsAssigneeAddedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: OnlineAds
          description: The webhook event type.
          example: OnlineAds
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: online_ads_assignee_added
          description: The webhook event name.
          example: online_ads_assignee_added
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/OnlineAds'
          description: The webhook `OnlineAds` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    UpdateOnlineAds:
      description: Update `OnlineAd` JSON parameters.
      properties:
        name:
          type: string
          description: The name of the `OnlineAds`.
          example: Google Ads
        description:
          type: string
          description: The description `OnlineAds`.
          example: Google Ads Campaign
        wallet_id:
          type: string
          description: The `Wallet` ID associated to the `OnlineAds`.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
    ISO4217Currency:
      type: string
      enum:
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BOV
      - BRL
      - BSD
      - BTN
      - BWP
      - BYN
      - BZD
      - CAD
      - CDF
      - CHE
      - CHF
      - CHW
      - CLF
      - CLP
      - CNY
      - COP
      - COU
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRO
      - MRU
      - MUR
      - MVR
      - MWK
      - MXN
      - MXV
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLE
      - SLL
      - SOS
      - SRD
      - SSP
      - STD
      - STN
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - USN
      - UYI
      - UYU
      - UYW
      - UZS
      - VED
      - VEF
      - VES
      - VND
      - VUV
      - WST
      - XAF
      - XAG
      - XAU
      - XBA
      - XBB
      - XBC
      - XBD
      - XCD
      - XDR
      - XOF
      - XPD
      - XPF
      - XPT
      - XSU
      - XTS
      - XUA
      - XXX
      - YER
      - ZAR
      - ZMW
      - ZWL
    WebhookEventType:
      type: string
      enum:
      - BusinessTrip
      - Card
      - Contact
      - ExpenseReview
      - Group
      - OnlineAds
      - Order
      - Purchase
      - Subscription
      - Transaction
      - TransactionAttachment
      - Employee
      - Vehicle
      - Wallet
    OnlineAdsDeletedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: OnlineAds
          description: The webhook event type.
          example: OnlineAds
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: online_ads_deleted
          description: The webhook event name.
          example: online_ads_deleted
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/OnlineAds'
          description: The webhook `OnlineAds` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    OnlineAdsAssigneeRemovedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: OnlineAds
          description: The webhook event type.
          example: OnlineAds
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: online_ads_assignee_removed
          description: The webhook event name.
          example: online_ads_assignee_removed
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/OnlineAds'
          description: The webhook `OnlineAds` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    AddAssignees:
      description: Add `Subscription` assignees JSON parameters.
      properties:
        add_assignees:
          type: array
          description: List of new `User` IDs to add as assignees.
          example:
          - XMPL1234-000001
          - XMPL1234-000002
          - XMPL1234-000003
          items:
            type: string
      required:
      - add_assignees
    OrderStatus:
      type: string
      enum:
      - PENDING
      - ERROR
      - PLACED
      - CANCELLED
      - COMPLETED
      - COMPLETED_WITH_CREDIT
    OnlineAdsActivatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: OnlineAds
          description: The webhook event type.
          example: OnlineAds
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: online_ads_activated
          description: The webhook event name.
          example: online_ads_activated
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/OnlineAds'
          description: The webhook `OnlineAds` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    Direction:
      type: string
      description: It indicates how the pages are ordered.
      enum:
      - ASC
      - DESC
      example: DESC
    CreateOnlineAds:
      description: Add `OnlineAd` JSON parameters.
      properties:
        name:
          type: string
          description: The name of the `OnlineAds`.
          example: Google Ads
        description:
          type: string
          description: The description of the `OnlineAds`.
          example: Google Ads Campaign
        platform:
          $ref: '#/components/schemas/OnlineAdsPlatform'
          description: The platform of the `OnlineAds`.
          example: GOOGLE
        assignees:
          type: array
          description: List of `User` IDs to be assigned to the `OnlineAds` and its `Cards`.
          example:
          - XMPL1234-000001
          - XMPL1234-000002
          - XMPL1234-000003
          items:
            type: string
          uniqueItems: true
        wallet_id:
          type: string
          description: 

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