Skip to main content
POST
Create a campaign template

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Body

application/json

Two payload shapes are accepted. If metadata, campaign AND triggers are all present the request is handled as a full import; otherwise it falls back to the legacy template-creation path. teams is taken from the request scope, not the body.

...
object

The campaign template object, as returned by GET /api/campaigns/export/:id.

metadata
object

Template metadata. Present with campaign and triggers, this selects the importer path.

campaign
object

The campaign definition to import.

triggers
array

The triggers belonging to the campaign.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

A campaign. Campaigns build on the base trigger fields, and each campaign type declares further fields of its own. Verified against a live GET /api/campaigns response.