Skip to main content
POST
/
public
/
v1
/
campaign-service
/
json-templates
Create Json Template
curl --request POST \
  --url https://api.topsort.com/public/v1/campaign-service/json-templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "previewScreenshot": "<string>",
  "adFormat": "banner",
  "previewUrl": "<string>",
  "jsonSchema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "properties": {
      "title": {
        "maxLength": 100,
        "minLength": 1,
        "type": "string"
      }
    },
    "required": [
      "title"
    ],
    "type": "object"
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "isArchived": false,
  "previewScreenshot": "<string>",
  "previewUrl": "<string>",
  "jsonSchema": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "adFormat": "banner"
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Body

application/json
​
name
string
required

Unique name of the JSON template

Required string length: 1 - 50
​
description
string
required

Description of the JSON template

Required string length: 1 - 100
​
jsonSchema
object
required

A JSON object that defines a schema according to draft-07 of the JSON Schema specification.

Examples:
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "title": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": ["title"],
  "type": "object"
}
​
previewScreenshot
string<uri> | null

Preview screenshot of the JSON template

Required string length: 1 - 2083
​
adFormat
enum<string> | null
default:banner

AdFormat this template is for The type of the ad format of the JSON template.

Available options:
banner,
sponsored_brand
​
previewUrl
string<uri> | null

Preview URL of the JSON template

Required string length: 1 - 2083

Response

Successful Response

​
id
string<uuid>
required

The ID of the JSON template

​
marketplaceId
string<uuid>
required

The ID of the marketplace

​
name
string
required

The name of the JSON template

​
description
string
required

The description of the JSON template

​
jsonSchema
object
required

The JSON schema of the JSON template

​
createdAt
string<date-time>
required

The creation time of the JSON template

​
updatedAt
string<date-time>
required

The update time of the JSON template

​
adFormat
enum<string>
required

The ad format of the JSON template

Available options:
banner,
sponsored_brand
​
isArchived
boolean
default:false

Whether the JSON template is archived

​
previewScreenshot
string<uri> | null

Preview screenshot of the JSON template

Required string length: 1 - 2083
​
previewUrl
string<uri> | null

Preview URL of the JSON template

Required string length: 1 - 2083