Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Online Ads

Add Online Ads

Endpoint to add a new OnlineAd.

post/business/v2/online-ads

Headers

X-Soldo-Fingerprintstring required

Advanced authentication: SHA512SUM of the fingerprint values listed in the fingerprint order for this endpoint.

Example:{{fingerprint}}
X-Soldo-Fingerprint-Signaturestring required

Advanced authentication: Signature of the X-Soldo-Fingerprint.

Example:{{fingerprint_signature}}

Request body

namestring required

The name of the OnlineAds.

descriptionstring required

The description of the OnlineAds.

platform'GOOGLE' | 'TWITTER' | 'TABOOLA' | 'PINTEREST' | 'MICROSOFT' | 'FACEBOOK' | 'AMAZON' | 'APPLE' | 'TIKTOK' | 'LINKEDIN' | 'INSTAGRAM' | 'OTHER' required
assigneesstring[] required

List of User IDs to be assigned to the OnlineAds and its Cards.

wallet_idstring required

The Wallet ID associated to the OnlineAds.

Example request

{
  "name": "Google Ads",
  "description": "Google Ads Campaign",
  "assignees": [
    "XMPL1234-000001",
    "XMPL1234-000002",
    "XMPL1234-000003"
  ],
  "wallet_id": "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
}

Response

The result is an OnlineAd.

idstring

The OnlineAds ID.

namestring

The name of the OnlineAds.

descriptionstring

A custom description of the OnlineAds.

platform'GOOGLE' | 'TWITTER' | 'TABOOLA' | 'PINTEREST' | 'MICROSOFT' | 'FACEBOOK' | 'AMAZON' | 'APPLE' | 'TIKTOK' | 'LINKEDIN' | 'INSTAGRAM' | 'OTHER'
assigneesstring[]

List of User IDs currently assigned to the OnlineAds and its Cards.

status'ACTIVE' | 'ASSIGNED' | 'CANCELLED'
wallet_idstring

The Wallet ID the OnlineAds and its Card are linked to.

last_spent_datestring

The date and time of the last Transaction made with the Card.

last_spentnumber

The amount of the last Transaction made with the Card.

total_spentnumber

The overall amount spent with the Card.

card_idstring

The ID of the Card reserved for this OnlineAds (only available after the OnlineAds has been activated).

creation_timestring

The date and time when the OnlineAds was created.

last_update_timestring

The date and time when the OnlineAds was last updated.

Example response

{
  "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "name": "EXAMPLE ONLINE AD",
  "description": "This is an online advertisement",
  "assignees": [
    "XMPL1234-000001",
    "XMPL1234-000002",
    "XMPL1234-000003"
  ],
  "wallet_id": "2d65bd5e-3fdf-4002-b166-bde7fb8863fa",
  "last_spent_date": "2020-05-07T12:48:40Z",
  "last_spent": 75.01,
  "total_spent": 775.01,
  "card_id": "c861cc24-6663-410f-8c78-73f886fff4ef",
  "creation_time": "2017-06-01T12:48:40Z",
  "last_update_time": "2017-06-01T12:48:40Z"
}