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

Get Developer Campaign

/api/v1/developer/campaigns/{campaignId}

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

Access scopecampaigns.read

Authorization: Bearer YOUR_PROJECT_TOKEN

Parameters

campaignIdrequired · path: stringminLength: 1 · maxLength: 160
JSON Schema
{ "type": "string", "minLength": 1, "maxLength": 160 }

Request examples

curl --request GET   'https://YOUR_NOVA_HOST/api/v1/developer/campaigns/CAMPAIGN_ID'   --header 'Authorization: Bearer YOUR_PROJECT_TOKEN'

Responses

200 Minimized Campaign lifecycle detail

application/json

object

idrequired

stringminLength: 1 · maxLength: 160

namerequired

stringminLength: 1 · maxLength: 160

statusrequired

stringenum: ["draft","scheduled","sending","paused","completed","cancelled"]

scheduledForrequired

string | nullformat: "date-time"

scheduleTimezonerequired

string | nullminLength: 1 · maxLength: 100

scheduleLocalDateTimerequired

string | nullpattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}$"

sendsPerMinuterequired

integer | nullexclusiveMinimum: 0

startedAtrequired

string | nullformat: "date-time"

pausedAtrequired

string | nullformat: "date-time"

completedAtrequired

string | nullformat: "date-time"

cancelledAtrequired

string | nullformat: "date-time"

versionrequired

integerexclusiveMinimum: 0

createdAtrequired

stringformat: "date-time"

updatedAtrequired

stringformat: "date-time"

preparationrequired

object

Nested schema

object

audienceFrozenrequired

boolean

templaterequired

object | null

Nested schema

object | null

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

JSON Schema

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

senderrequired

object | null

Nested schema

object | null

channelIdrequired: stringminLength: 1 · maxLength: 160
providerTyperequired: stringminLength: 1 · maxLength: 100

JSON Schema

{
  "type": [
    "object",
    "null"
  ],
  "properties": {
    "channelId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "providerType": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    }
  },
  "required": [
    "channelId",
    "providerType"
  ],
  "additionalProperties": false
}

fallbackRouterequired

object | null

Nested schema

object | null

templaterequired

object

Nested schema

object

templateIdrequired: stringminLength: 1 · maxLength: 160
versionrequired: integerexclusiveMinimum: 0
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
    },
    "channelType": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "locale": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    }
  },
  "required": [
    "templateId",
    "version",
    "channelType",
    "locale"
  ],
  "additionalProperties": false
}

senderrequired

object

Nested schema

object

channelIdrequired: stringminLength: 1 · maxLength: 160
providerTyperequired: stringminLength: 1 · maxLength: 100

JSON Schema

{
  "type": "object",
  "properties": {
    "channelId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "providerType": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    }
  },
  "required": [
    "channelId",
    "providerType"
  ],
  "additionalProperties": false
}

JSON Schema

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

configurationReadyrequired

boolean

missingrequired

arraymaxItems: 4

Nested schema

arraymaxItems: 4

stringenum: ["audience","template","sender","primary_route_mismatch"]

JSON Schema

{
  "type": "string",
  "enum": [
    "audience",
    "template",
    "sender",
    "primary_route_mismatch"
  ]
}

JSON Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "audience",
      "template",
      "sender",
      "primary_route_mismatch"
    ]
  },
  "maxItems": 4
}

JSON Schema

{
  "type": "object",
  "properties": {
    "audienceFrozen": {
      "type": "boolean"
    },
    "template": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "templateId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 160
        },
        "version": {
          "type": "integer",
          "exclusiveMinimum": 0
        },
        "channelType": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "locale": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "templateId",
        "version",
        "channelType",
        "locale"
      ],
      "additionalProperties": false
    },
    "sender": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "channelId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 160
        },
        "providerType": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "channelId",
        "providerType"
      ],
      "additionalProperties": false
    },
    "fallbackRoute": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "template": {
          "type": "object",
          "properties": {
            "templateId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            },
            "version": {
              "type": "integer",
              "exclusiveMinimum": 0
            },
            "channelType": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "locale": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            }
          },
          "required": [
            "templateId",
            "version",
            "channelType",
            "locale"
          ],
          "additionalProperties": false
        },
        "sender": {
          "type": "object",
          "properties": {
            "channelId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            },
            "providerType": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            }
          },
          "required": [
            "channelId",
            "providerType"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "template",
        "sender"
      ],
      "additionalProperties": false
    },
    "configurationReady": {
      "type": "boolean"
    },
    "missing": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "audience",
          "template",
          "sender",
          "primary_route_mismatch"
        ]
      },
      "maxItems": 4
    }
  },
  "required": [
    "audienceFrozen",
    "template",
    "sender",
    "fallbackRoute",
    "configurationReady",
    "missing"
  ],
  "additionalProperties": false
}

JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "scheduled",
        "sending",
        "paused",
        "completed",
        "cancelled"
      ]
    },
    "scheduledFor": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "scheduleTimezone": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "maxLength": 100
    },
    "scheduleLocalDateTime": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}$"
    },
    "sendsPerMinute": {
      "type": [
        "integer",
        "null"
      ],
      "exclusiveMinimum": 0
    },
    "startedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "pausedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "completedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "cancelledAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "version": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "preparation": {
      "type": "object",
      "properties": {
        "audienceFrozen": {
          "type": "boolean"
        },
        "template": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "templateId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            },
            "version": {
              "type": "integer",
              "exclusiveMinimum": 0
            },
            "channelType": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "locale": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            }
          },
          "required": [
            "templateId",
            "version",
            "channelType",
            "locale"
          ],
          "additionalProperties": false
        },
        "sender": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "channelId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            },
            "providerType": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            }
          },
          "required": [
            "channelId",
            "providerType"
          ],
          "additionalProperties": false
        },
        "fallbackRoute": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "template": {
              "type": "object",
              "properties": {
                "templateId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 160
                },
                "version": {
                  "type": "integer",
                  "exclusiveMinimum": 0
                },
                "channelType": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "locale": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                }
              },
              "required": [
                "templateId",
                "version",
                "channelType",
                "locale"
              ],
              "additionalProperties": false
            },
            "sender": {
              "type": "object",
              "properties": {
                "channelId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 160
                },
                "providerType": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                }
              },
              "required": [
                "channelId",
                "providerType"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "template",
            "sender"
          ],
          "additionalProperties": false
        },
        "configurationReady": {
          "type": "boolean"
        },
        "missing": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "audience",
              "template",
              "sender",
              "primary_route_mismatch"
            ]
          },
          "maxItems": 4
        }
      },
      "required": [
        "audienceFrozen",
        "template",
        "sender",
        "fallbackRoute",
        "configurationReady",
        "missing"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "name",
    "status",
    "scheduledFor",
    "scheduleTimezone",
    "scheduleLocalDateTime",
    "sendsPerMinute",
    "startedAt",
    "pausedAt",
    "completedAt",
    "cancelledAt",
    "version",
    "createdAt",
    "updatedAt",
    "preparation"
  ],
  "additionalProperties": false,
  "$ref": "#/components/schemas/DeveloperCampaignDetailResponse"
}

400 Invalid Campaign identifier

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"
  ]
}

404 Campaign not found

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"
  ]
}