Campaign API

Create Json Template

Endpoint to create a new JSON template.

post/public/v1/campaign-service/json-templates

Request

  • Base URL: https://api.topsort.com
  • URL: https://api.topsort.com/public/v1/campaign-service/json-templates
  • Auth: HTTP bearer

Request body

namestring required

Unique name of the JSON template

descriptionstring required

Description of the JSON template

previewScreenshotstring uri nullable

Preview screenshot of the JSON template

adFormat'banner' | 'sponsored_brand'

The type of the ad format of the JSON template.

previewUrlstring uri nullable

Preview URL of the JSON template

jsonSchemaobject required

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

Example request

{
  "jsonSchema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "properties": {
      "title": {
        "maxLength": 100,
        "minLength": 1,
        "type": "string"
      }
    },
    "required": [
      "title"
    ],
    "type": "object"
  }
}

Response

Successful Response

idstring uuid required

The ID of the JSON template

marketplaceIdstring uuid required

The ID of the marketplace

namestring required

The name of the JSON template

descriptionstring required

The description of the JSON template

isArchivedboolean

Whether the JSON template is archived

previewScreenshotstring uri nullable

Preview screenshot of the JSON template

previewUrlstring uri nullable

Preview URL of the JSON template

jsonSchemaobject required

The JSON schema of the JSON template

createdAtstring date-time required

The creation time of the JSON template

updatedAtstring date-time required

The update time of the JSON template

adFormat'banner' | 'sponsored_brand' required

The type of the ad format of the JSON template.

Changes

No recorded changes to this operation across all 1 revision of this API.