DEVELOPER PLATFORM · v1

An API you can build with

CRM, campaigns, analytics and integrations. Exact contracts, practical examples and signed webhooks.

Download OpenAPI

Private preview: use a project API key. Public SLA and support windows have not been established yet.

GET

List Developer Campaign Templates

/api/v1/developer/campaigns/templates

Use the access scope below. The generated schemas specify the exact request and responses.

Access scopecampaigns.read

Authorization: Bearer YOUR_PROJECT_TOKEN

Parameters

limitoptional · query: integerminimum: 1 · maximum: 100 · default: 50
JSON Schema
{ "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }
cursoroptional · query: stringminLength: 1 · maxLength: 4096
JSON Schema
{ "type": "string", "minLength": 1, "maxLength": 4096 }

Request examples

curl --request GET \
  'https://YOUR_NOVA_HOST/api/v1/developer/campaigns/templates?limit=50' \
  --header 'Authorization: Bearer YOUR_PROJECT_TOKEN'

Responses

200 Published Campaign template selection catalog

application/json

object

templatesrequired

arraymaxItems: 1000

Nested schema

arraymaxItems: 1000

object

templateIdrequired: stringminLength: 1 · maxLength: 160
versionrequired: integerexclusiveMinimum: 0
namerequired: stringminLength: 1 · maxLength: 160
channelTyperequired: stringminLength: 1 · maxLength: 100
localerequired: stringminLength: 1 · maxLength: 100

JSON Schema

{
  "type": "object",
  "properties": {
    "templateId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "channelType": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "locale": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    }
  },
  "required": [
    "templateId",
    "version",
    "name",
    "channelType",
    "locale"
  ],
  "additionalProperties": false
}

JSON Schema

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "templateId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "version": {
        "type": "integer",
        "exclusiveMinimum": 0
      },
      "name": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "channelType": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      },
      "locale": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      }
    },
    "required": [
      "templateId",
      "version",
      "name",
      "channelType",
      "locale"
    ],
    "additionalProperties": false
  },
  "maxItems": 1000
}

nextCursor

string | null

JSON Schema

{
  "type": "object",
  "properties": {
    "templates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "templateId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 160
          },
          "version": {
            "type": "integer",
            "exclusiveMinimum": 0
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 160
          },
          "channelType": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "locale": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          }
        },
        "required": [
          "templateId",
          "version",
          "name",
          "channelType",
          "locale"
        ],
        "additionalProperties": false
      },
      "maxItems": 1000
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "templates"
  ],
  "additionalProperties": false,
  "$ref": "#/components/schemas/DeveloperCampaignPublishedTemplatesResponse"
}

400 Invalid Campaign template page

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

401 Invalid developer credential

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

403 Campaign directory unavailable

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

429 Developer API rate limit exceeded

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

503 Developer API rate limiter unavailable

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}