How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cardlytics Campaigns API

The Campaigns API from Cardlytics — 14 operation(s) for campaigns.

Cardlytics Campaigns API is one of 18 APIs that Cardlytics publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and a changelog.

This API exposes 17 operations across 14 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version latest.

Requests are made against a single base URL, https://api.cardlytics.com.

17 operations 14 paths 17 schemas 1 DELETE10 GET2 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
latest
Base URL
https://api.cardlytics.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Cardlytics Campaigns API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2-cognito) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 17

Across 14 paths, the API surfaces 17 operations — 1 DELETE, 10 GET, 2 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Campaigns 17
GET
/v7/accounts/{accountId}/Campaigns
Returns all Campaigns from the repository for a given account.
5 params → 200403404
POST
/v7/accounts/{accountId}/Campaigns
Adds a Campaign to the repository.
1 param body → 201403
GET
/v7/Campaigns
Returns all Campaigns from the repository.
4 params → 200404
GET
/v7/accounts/{accountId}/Campaigns/{campaignId}
Returns a Campaign from the repository for a given account by its CampaignId.
2 params → 200403404
PATCH
/v7/accounts/{accountId}/Campaigns/{campaignId}
Updates the partial modifications to a Campaign.
2 params body → 200400403404
DELETE
/v7/accounts/{accountId}/Campaigns/{campaignId}
Deletes a Campaign with all related entities (AdGroup, Ad, Audience etc.) DELETE accounts/{accountId}/Campaigns/{campaignId}
2 params → 204400403404
GET
/v7/Campaigns/{campaignId}
Returns a Campaign from the repository by its CampaignId.
1 param → 200403404
GET
/v7/accounts/{accountId}/Campaigns/{campaignId}/diff
Returns a difference between the two versions of the Campaign.
4 params → 200403404
PATCH
/v7/accounts/{accountId}/Campaigns/{campaignId}/optimize
Updates the partial modifications to a Campaign with only optimize Campaign fields.
2 params body → 200400403404
PUT
/v7/accounts/{accountId}/Campaigns/{campaignId}/status
Updates the Status of a Campaign. Use this endpoint to apply changes to the Campaign Status, for example resulting from user action.
2 params body → 200400403404
GET
/v7/accounts/{accountId}/Campaigns/{campaignId}/versions
Returns all versions of a Campaign. A version is created when a CampaignBuilt event is published for a campaign.
2 params → 200403404
GET
/v7/accounts/{accountId}/Campaigns/{campaignId}/versions/latest
Returns the latest version of a Campaign. A version is created when a CampaignBuilt event is published for a campaign.
2 params → 200403404
POST
/v7/accounts/{accountId}/Campaigns/{campaignId}/projection
Creates a CampaignProjection request and saves the request to the repository.
2 params → 201400403404
POST
/v7/accounts/{accountId}/Campaigns/{campaignId}/duplicate
Duplicates a Campaign with all related entities (AdGroup, Ad, Audience, Ad pricing models, etc.)
3 params → 303400403404
GET
/v7/accounts/{accountId}/Campaigns/{campaignId}/validation
Validates a Campaign with all business rules.
2 params → 200403404
GET
/v7/Campaigns/validation/rule-set
Returns validation rules for a Campaign object.
→ 200
GET
/v7/Campaigns/count
Calculates the aggregate count of campaigns partitioned by the campaign status. Only counts those objects which the user has been granted access.
1 param → 200400

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are GetCampaignResourceModel (22 properties), PostCampaignResourceModel (15 properties), GetValidationResourceModel (7 properties), ProblemDetails (5 properties). Each schema is shown below with its type and property counts.

GetValidationDefinitionResourceModel
object
Get Validation Definition resource model.
2 properties
GetCampaignProjectionResourceModel
object
3 properties
CampaignPricingModel
string
Campaign PricingModel enumeration. This must be kept in step with Cardlytics.Api.CampaignBuild.Repository.Entities.CampaignPricingModel.
Operation
object
4 properties
RuleDefinition
object
4 properties
GetValidationResourceModel
object
Get Validation endpoint resource model.
7 properties
CampaignObjective
string
GetCampaignVersionResourceModel
object
2 properties
CampaignType
string
CampaignType enumeration.
ScheduleType
string
Schedule Type enumeration. This must be kept in step with Cardlytics.Api.CampaignBuild.Repository.Entities.ScheduleType.
PutCampaignStatusResourceModel
object
1 property
GetCampaignResourceModel
object
22 properties
PostCampaignResourceModel
object
15 properties 6 required
ProblemDetails
object
5 properties
Currency
string
CampaignStatus
string
Campaign status enumeration.
RuleTypes
string
Validation rule definition types.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cardlytics-campaigns-api-openapi.yml Raw ↑

Other APIs Cardlytics publishes across the network.

Cardlytics Ad Groups API
Cardlytics Ads API
Cardlytics Ads Controller API
Cardlytics Audience Reach API
Cardlytics Audiences API
Cardlytics Audit Logs API
Cardlytics Authentication API
Cardlytics Customer Controller API
Cardlytics Geo API
Cardlytics Merchants API
Cardlytics Offers API
Cardlytics Pricing Models API
Where this information came from

This is an independent, third-party profile of Cardlytics Campaigns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.