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 Ads API

The Ads API from Cardlytics — 10 operation(s) for ads.

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

Tagged areas include Ads. 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 14 operations across 10 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version latest.

Requests are made against the base URL https://api.cardlytics.com.

14 operations 10 paths 14 schemas 1 DELETE8 GET1 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 Ads 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 14

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

Ads 14
GET
/v7/accounts/{accountId}/Ads/{adId}
Returns an Ad from the repository for a given account by its adId
getV7AccountsByAccountIdAdsByAdId 2 params → 200403404
PATCH
/v7/accounts/{accountId}/Ads/{adId}
Updates the partial modifications to an Ad
patchV7AccountsByAccountIdAdsByAdId 2 params body → 200400403404
DELETE
/v7/accounts/{accountId}/Ads/{adId}
Deletes an Ad with all related entities (Reward, Pricing models, etc.) DELETE…
deleteV7AccountsByAccountIdAdsByAdId 2 params → 204400403404
GET
/v7/Ads/{adId}
Returns an Ad from the repository by its adId
getV7AdsByAdId 1 param → 200404
GET
/v7/Ads/{adId}/RedeemingMerchants
Gets the RedeemingMerchants associated with an Ad
getV7AdsByAdIdRedeemingMerchants 1 param → 200404
POST
/v7/accounts/{accountId}/Ads/{adId}/RedeemingMerchants
Creates an Ad's Redeeming Merchants List
postV7AccountsByAccountIdAdsByAdIdRedeemingMerchants 2 params body → 201403
PUT
/v7/accounts/{accountId}/Ads/{adId}/RedeemingMerchants
Updates the partial modifications to an Ad's Redeeming Merchants List
putV7AccountsByAccountIdAdsByAdIdRedeemingMerchants 2 params body → 200400403404
GET
/v7/accounts/{accountId}/Ads
Returns all Ads from the repository for a given account
getV7AccountsByAccountIdAds 5 params → 200403
POST
/v7/accounts/{accountId}/Ads
Adds an Ad to the repository
postV7AccountsByAccountIdAds 1 param body → 201403
GET
/v7/accounts/{accountId}/campaigns/{campaignId}/Ads
Returns all Ads from the repository for a given Campaign
getV7AccountsByAccountIdCampaignsByCampaignIdAds 4 params → 200403
GET
/v7/Ads
Returns all Ads from the repository
getV7Ads 4 params → 200
POST
/v7/accounts/{accountId}/Ads/{adId}/duplicate
Duplicates an Ad with all related entities (Reward, Pricing models, etc.) POST…
postV7AccountsByAccountIdAdsByAdIdDuplicate 3 params → 303400403404
GET
/v7/accounts/{accountId}/Ads/{adId}/validation
Validates a Ad with all business rules
getV7AccountsByAccountIdAdsByAdIdValidation 2 params → 200403404
GET
/v7/Ads/validation/rule-set
Returns validation rules for a Ad object
getV7AdsValidationRuleSet → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are GetAdResourceModel (11 properties), GetValidationResourceModel (7 properties), PutRedeemingMerchantResourceModel (6 properties), GetRedeemingMerchantResourceModel (6 properties). Each schema is shown below with its type and property counts.

RuleDefinition
object
4 properties
SegmentResourceModel
object
2 properties
GetValidationDefinitionResourceModel
object
Get Validation Definition resource model.
2 properties
PostRedeemingMerchantResourceModel
object
6 properties 3 required
Operation
object
4 properties
RuleTypes
string
Validation rule definition types.
GetValidationResourceModel
object
Get Validation endpoint resource model.
7 properties
PostAdResourceModel
object
3 properties 1 required
ProblemDetails
object
5 properties
SegmentDataResourceModel
object
4 properties 1 required
CampaignStatus
string
Campaign status enumeration.
GetRedeemingMerchantResourceModel
object
6 properties 3 required
PutRedeemingMerchantResourceModel
object
6 properties
GetAdResourceModel
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cardlytics-ads-api-openapi.yml Raw ↑

Other APIs Cardlytics publishes across the network.

Cardlytics Ads Controller API
Cardlytics Audience Reach API
Cardlytics Audiences API
Cardlytics Authentication API
Cardlytics Campaigns API
Cardlytics Customer Controller API
Cardlytics Geo API
Cardlytics Merchants API
Cardlytics Offers API
Cardlytics Pricing Models API
Cardlytics Redemptions API
Cardlytics Reports API
Where this information came from

This is an independent, third-party profile of Cardlytics Ads 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.