Skip to main content
POST
Create Json Template

Authorizations

Authorization
string
header
required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

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
Jsonschema · object
required

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

Example:
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

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
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