API

The API helps you automate data collection in ExpertSender. You can track customer behavior, orders, and other important events without manual work.

What events can you handle with ExpertSender API?

You can automate these tasks:

• Adding new customers to your database.
• Updating customer information that’s already in your system.
• Recording orders when customers make purchases.
• Adding custom events in scenarios for specific business needs.

API server address

All endpoints use the same address structure: https://api.ecdp.app/xxx

Replace “xxx” with the specific endpoint name – like orders, customers, or scenariocustomevents.

You’ll find exact addresses in each API method description below.

API key – authentication

Your API key authenticates requests from external applications. This lets you send customer behavior data to ExpertSender securely. Each business unit gets its own unique API key.

Find yours here: Settings > API. Copy it and add it to your application or client for API requests.

Managing multiple business units? Each one requires its own API key.

How to use ExpertSender API?

Use any API client or application you’re already comfortable with. The best tool is the one you know.

Here’s what you need to do:

1. Add your business unit’s API key to your client.
2. Send a request for the data you want.
3. Include your API key in every request.

An API request is part of an API call. The server processes your request and sends back the data you asked for.

API call

Your request needs three things to work:

• The right address (endpoint).
• Proper format (syntax).
• The correct method.

Each method has different syntax requirements. Check the method descriptions below for details.

API methods

For each resource, we use the following methods:

Customers:

• POST – add information about a new customer.
• GET {id} – get customer information using their ID number.
• GET {email} – get customer information using their email address.
• GET {phone} – get customer information using their phone number.
• GET {crmId} – get customer information using their CRM ID number.

Orders:

• POST – add information about a new order.
• GET – get order information using the order number.
• PUT – update order status.
• DELETE – change order status to deleted.

Custom events in scenarios:

• POST – add information about customers or orders from non-standard events (like in-store purchases with loyalty cards).

Getting a list of customer attributes.

Getting a consent list.

Getting a list of order attributes.

Getting a list of product attributes.

API response codes

When you send a request, the server responds with a code. Here are the most common ones:

Different methods might return different response codes. Check each method’s documentation for specific codes.