Contacts

Learn how to use Contact API to Create, Update, Search and Delete Contacts.

The Contacts API V5 provides APIs to create, search, update, and delete contacts. The supplied specification defines synchronous and asynchronous operations.

👍

Important Point to Remember

  • Create, Update, and Delete are asynchronous operations
  • A successful response confirms that the request was accepted and it does not confirm that processing has completed.
📘

Prerequisites

Ensure the below is done before you start:

  • You have a valid Netcore API key. Refer here to get you API key.
  • Use Content-Type: application/json.
  • Use the regional base URL applicable to your account.
  • Understand identified vs anonymous contacts.
    • Identified: Used when the contact has a primary identity available in Netcore CE.
    • Anonymous: Used when the contact's primary identity is not available in Netcore CE.
  • Understand the account's configured primary key.

Contact API Operations

TaskEndpointProcessing
Create contactsPOST /contact/createAsynchronous
Search contactsPOST /contact/searchSynchronous
Update contactsPOST /contact/updateAsynchronous
Delete contactsPOST /contact/deleteAsynchronous
Search within an audiencePOST /contact/audience/searchSynchronous
Upsert contactsPOST /contact/upsertAsynchronous

Authentication

POST {{BASE_URL}}/contact/create
api-key: YOUR_API_KEY
Content-Type: application/json
📘

Important: Replace YOUR_API_KEY with your actual API key.

Contact Types

ValueMeaningKey rule
identifiedIdentified contactidentity is required.
anonymousAnonymous contactIdentifier requirements differ from identified contacts.

Request

curl --location --request POST '{{BASE_URL}}/contact/create' \
--header 'api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "data": {
    "contact_type": "identified",
    "contacts": [
      {
        "identity": "john.doe",
        "email": "[email protected]"
      }
    ]
  }
}

A successful response means the request was accepted for asynchronous processing.

Success Response

{
  "request_id": "a7add3e4-2206-49f6-927e-3dfd917b906a",
  "code": 200,
  "status": "success",
  "description": "Your request was accepted successfully. It is being processed asynchronously."
}

Base URLs by Region