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

Cordial Contacts API

The contacts API from Cordial — 17 operation(s) for contacts.

Cordial Contacts API is one of 25 APIs that Cordial publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contacts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

Requests are made against a single base URL, https://api.cordial.io/.

27 operations 17 paths 33 schemas 7 DELETE4 GET10 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.cordial.io/v2
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Cordial Contacts API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth).

  • basicAuth — HTTP Basic Authentication. Works over HTTPS

Paths & Operations 27

Across 17 paths, the API surfaces 27 operations — 7 DELETE, 4 GET, 10 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

contacts 27
POST
/v1/contacts/{primary_key}/downloadprofile
Export Contact Profile
buildcontactprofile 1 param body → 201404
POST
/v1/contacts
Add a new contact to the system
addContact body → 201405
GET
/v1/contacts
Get contacts
getContacts 7 params → 200404
PUT
/v1/contacts/{primary_key}
Update an existing contact
updateContacts 1 param body → 200404
GET
/v1/contacts/{primary_key}
Get a single contact
getsinglecontact 1 param → 200404
DELETE
/v1/contacts/{primary_key}
Delete a single contact
deletesinglecontact 1 param → 200404
PUT
/v1/contacts/{primary_key}/unsubscribe/{channel}
Unsubscribe contact by primary Key with channel
unsubscribecontact 3 params → 200404
POST
/v1/contacts/{primary_key}/cart
Add cart object to contact
savecartcontact 1 param body → 200404
PUT
/v1/contacts/{primary_key}/cart
Update cart
updatecartcontact 1 param body → 200404
DELETE
/v1/contacts/{primary_key}/cart
Remove cart object from contact
clearcartcontact 1 param → 200404
POST
/v1/contacts/{primary_key}/cartitems
Add product to cart
addproducttocartcontact 1 param body → 200404
DELETE
/v1/contacts/{primary_key}/cartitems/{productID}
Remove product from cart
removeproducttocartcontact 2 params → 200404
DELETE
/v1/contacts/{primary_key}/cartitems/{productID}/{qty}
Remove product from cart by Qty
removeproducttocartqtycontact 3 params → 200404
POST
/v2/contacts
Add a contact
addContact body → 201422
GET
/v2/contacts
Get contacts
getContacts 7 params → 200404
PUT
/v2/contacts/{primary_key}
Update a contact
updateContacts 1 param body → 200404422
GET
/v2/contacts/{primary_key}
Get a single contact
getsinglecontact 1 param → 200404
DELETE
/v2/contacts/{primary_key}
Delete a single contact
deletesinglecontact 1 param → 200404
PUT
/v2/contacts/{primary_key}/unsubscribe/{channel}
Unsubscribe a contact
unsubscribecontact 3 params → 200404422
POST
/v2/contacts/merge
Merges two contacts
mergecontacts body → 201403422500
POST
/v2/contacts/split
Splits a contact
splitContact body → 202403404422500
POST
/v2/contacts/{primary_key}/cart
Add contact cart object
savecartcontact 1 param body → 200422
PUT
/v2/contacts/{primary_key}/cart
Update contact cart object
updatecartcontact 1 param body → 200404422
DELETE
/v2/contacts/{primary_key}/cart
Remove contact cart object
clearcartcontact 1 param → 200404422
POST
/v2/contacts/{primary_key}/cartitems
Add product to cart
addproducttocartcontact 1 param body → 200422
DELETE
/v2/contacts/{primary_key}/cartitems/{productID}/{qty}/{sku}
Remove product from cart in quantities by product ID and, optionally, SKU
removeproducttocartqtycontact 4 params → 200404422
POST
/v2/contacts/{primary_key}/downloadprofile
Download contact profile
buildcontactprofile 1 param body → 201404422

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are DestinationObject (14 properties), CartitemsC (11 properties), CartitemsC_2 (11 properties), DestinationCE (10 properties). Each schema is shown below with its type and property counts.

SplitContact
object
2 properties 2 required
MergeContactsFeatureError
object
3 properties 3 required
SplitContactNotFoundError
object
3 properties 3 required
CartC
object
9 properties 1 required
SourceCPB
object
1 property 1 required
MergeContactsError
object
3 properties 3 required
ContactDownloadProfileError
object
3 properties 3 required
SplitContactSuccess
object
3 properties 3 required
CartitemsC_2
object
11 properties 4 required
CartC_2
object
9 properties 1 required
EmailC
object
2 properties 1 required
SourceCPB_2
object
1 property 1 required
ChannelC
object
1 property 1 required
MergeContactsSuccess
object
2 properties 2 required
ContactCreated
object
3 properties 3 required
SuccessOperation
object
1 property 1 required
CartitemsC
object
11 properties 4 required
RecordNotFound
object
3 properties 2 required
DestinationObject
object
14 properties 1 required
ContactCPost
object
5 properties 1 required
ContactError
object
3 properties 3 required
DestinationCE
object
10 properties 2 required
ContactCPut
object
5 properties 1 required
ContactCartError
object
3 properties 3 required
MergeContacts
object
3 properties 3 required
SplitContactRequestError
object
3 properties 3 required
ContactC_2
object
3 properties 1 required
SplitContactApplicationError
object
3 properties 3 required
ContactDownloadProfileSuccess
object
1 property 1 required
MergeContactsOptions
object
9 properties 9 required
ContactC
object
3 properties 1 required
MergeContactsServerError
object
3 properties 3 required
SplitContactNotAvailable
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cordial-contacts-api-openapi.yml Raw ↑

Other APIs Cordial publishes across the network.

Cordial MCP Server
Cordial account attributes API
Cordial account lists API
Cordial account monitor export API
Cordial Alerts API
Cordial analytics audiences API
Cordial analytics messages API
Cordial Audiencecount API
Cordial automation templates API
Cordial batch messages API
Cordial contact activities API
Cordial contact activity exports API
Where this information came from

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