Campaigns

Create a campaign

The body is strict: a field it does not know is rejected with 400, not silently ignored. Better an error on the first attempt than a setting that looks applied and is not.

Required scope: CAMPAIGNS_WRITE.

post/partner/campaigns

Request

  • Base URL: https://app.comunicate.eu/api/v1
  • URL: https://app.comunicate.eu/api/v1/partner/campaigns
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.comunicate.eu/api/v1/oauth/authorize, token URL https://app.comunicate.eu/api/v1/oauth/token, scopes: CAMPAIGNS_WRITE)

Request body

namestring required

Campaign name.

campaignTypestring

Binds the campaign to a type. Every article that joins it is checked automatically against the type’s requirements, and the verdict appears on the article in potrivireCampanie. It does not block writing — rejection stays at the order, where the payment is.

clientNamestring

The end client’s label. Free text: clients have no account on the platform.

objectivestring

What the campaign is for.

notesstring

Internal notes.

startsAtstring date-time

ISO 8601. Must precede endsAt.

endsAtstring date-time

ISO 8601.

budgetCentsinteger

A tracked budget, in minor units. Not a separate wallet: the money stays in the organisation’s account.

budgetCreditsinteger

Limit on credits spent in the campaign.

allowedSiteIdsstring

Allowed sites. Empty means “any in the catalogue”.

idempotencyKeystring

Chosen by you — a locally generated UUID is enough. Sent again, for the same organisation, it returns the campaign already created instead of making a new one. Recommended for any code that might resend the request after a timeout.

Response

OK

object required

Changes

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