Blueshift API

Name: Blueshift API
Brand: Blueshift API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentMarketingMarketing Automationbasic44 EndpointsREST

For Agents

Send customer events into Blueshift, manage cross-channel campaigns and templates, and orchestrate triggered email, push, and SMS sends.

Install Jentic One Beta

Connect the Blueshift API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Blueshift API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Blueshift API.

Ingest customer events one at a time or in bulk for triggered campaigns

Create, schedule, launch, pause, and archive cross-channel campaigns

Update customer profile attributes and merge or forget customers for privacy compliance

GET STARTED

Start building with Blueshift API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Blueshift API, keeping it validated and agent-ready. Blueshift is a customer data and cross-channel marketing automation platform, and the API exposes campaigns, customer events, customer profiles, email/push/SMS templates, catalogs, segments, custom user lists, promotions, shared assets, email validation, and subscription groups. It supports both event ingestion and campaign orchestration, including ad-hoc and scheduled launches plus bulk executions. Authentication uses HTTP Basic with API key credentials issued from the Blueshift dashboard.

Use Cases

Patterns agents use Blueshift API for, with concrete tasks.

★ Server-side event ingestion

Pipe customer behaviour events from a backend or data pipeline into Blueshift to power triggered campaigns. POST /api/v1/event accepts a single event with customer identifiers, event name, and properties; POST /api/v1/bulkevents accepts up to several thousand at a time. Use GET /api/v1/event/debug to verify ingestion during integration. Suitable for replacing client-side SDK telemetry with server-of-record event streams.

Call POST /api/v1/event with event_name='order_completed', customer_id, and order_value to trigger downstream campaigns.

Programmatic campaign orchestration

Create, schedule, and launch Blueshift campaigns from outside the dashboard. POST /api/v1/campaigns creates a campaign, PATCH /api/v1/campaigns/{campaignUuid}/schedule sets timing, and PATCH /api/v1/campaigns/{campaignUuid}/launch makes it live. PATCH .../pause and PUT .../archive provide the rest of the lifecycle. Useful for replicating campaigns across environments and for CI-driven marketing automation.

Call POST /api/v1/campaigns with the campaign payload, then PATCH /api/v1/campaigns/{campaignUuid}/launch to make it live.

Ad-hoc transactional sends

Trigger one-off transactional or transactional-style sends to specific customers via campaign execute endpoints. POST /api/v1/campaigns/execute runs a campaign for a single customer; POST /api/v1/campaigns/bulk-execute runs it for a list. Useful for order confirmations, password resets, or account notifications where the message body lives in a Blueshift template but the trigger is event-driven outside Blueshift.

Call POST /api/v1/campaigns/execute with campaign_uuid and a single customer_id to send a confirmation email.

Privacy compliance workflows

Honour data subject requests by deleting or anonymising customer records. POST /api/v1/customers/delete hard-deletes a profile; POST /api/v1/customers/forget anonymises while keeping aggregate metrics; POST /api/v1/customers/merge consolidates duplicate profiles. Useful for GDPR, CCPA, and other privacy-led customer record hygiene.

Call POST /api/v1/customers/forget with customer_id to anonymise the record in line with a data subject request.

AI agent marketing copilot

Let an AI agent run marketing operations on behalf of a marketer — pause an in-flight campaign, trigger a transactional send, or look up a segment. The agent searches Jentic for the right Blueshift operation by intent, loads the schema, and executes with the Basic auth credentials held in the Jentic vault. Suitable for Slack-based marketing copilots and customer support agents who need to trigger account notifications.

Search Jentic for 'pause a Blueshift campaign', load the schema, and execute it for the campaignUuid that triggered an alert.

Key Endpoints

44 endpoints — jentic publishes the only available openapi specification for blueshift api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/api/v1/event

Send a single customer event

POST

/api/v1/bulkevents

Send a batch of customer events

POST

/api/v1/campaigns/execute

Trigger a campaign send for one customer

PATCH

/api/v1/campaigns/{campaignUuid}/launch

Launch a draft campaign

PATCH

/api/v1/campaigns/{campaignUuid}/pause

Pause a running campaign

POST

/api/v1/customers

Create or upsert a customer profile

POST

/api/v1/customers/forget

Anonymise a customer record

GET

/api/v1/emails/validate

Validate a single email address

POST

/api/v1/event

Send a single customer event

POST

/api/v1/bulkevents

Send a batch of customer events

POST

/api/v1/campaigns/execute

Trigger a campaign send for one customer

PATCH

/api/v1/campaigns/{campaignUuid}/launch

Launch a draft campaign

PATCH

/api/v1/campaigns/{campaignUuid}/pause

Pause a running campaign

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Blueshift API key Basic-auth credentials are stored encrypted in the Jentic vault. Agents receive scoped execution access — the raw API key never enters agent context, and per-environment keys (sandbox vs production) are isolated under separate credentials.

Intent-based discovery

Agents search by intent (e.g. 'send a customer event' or 'launch a campaign') and Jentic returns the matching Blueshift operation across the 44 endpoints with its input schema, so the agent can call the right path without browsing the docs site.

Time to first call

Direct integration: 1-2 days for event payload mapping, campaign lifecycle handling, and bulk endpoint pagination. Through Jentic: under 30 minutes — search, load, execute.

FAQs

Specific to using Blueshift API through Jentic.

Why is there no official OpenAPI spec for Blueshift API?

Blueshift publishes a developer documentation site but does not distribute a maintained OpenAPI 3 file. Jentic generates and maintains this spec so AI agents and developers can call Blueshift via standard tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Blueshift API use?

Blueshift uses HTTP Basic Authentication with API key credentials issued from the Blueshift dashboard. The username is the Event API key and the password is left empty (or vice versa, depending on endpoint group). Through Jentic, the credentials are held in the encrypted vault and injected at execution, so the agent never sees them.

Can I send customer events through this API?

Yes. POST /api/v1/event accepts a single event with event_name and customer identifier (customer_id or email). POST /api/v1/bulkevents accepts an array of up to several thousand events per call for batch ingestion. Use GET /api/v1/event/debug to verify a recent event was accepted by the platform.

What are the rate limits for the Blueshift API?

Blueshift applies per-account rate limits that are not enumerated in the spec. The published guidance is to keep event volume under a few hundred requests per second per account; HTTP 429 responses include a Retry-After header. Higher throughput is available on enterprise plans by request.

How do I trigger a one-off campaign send through Jentic?

Search Jentic for 'trigger a Blueshift campaign for one customer', load the schema for POST /api/v1/campaigns/execute, and execute it with campaign_uuid and customer_id. Install with pip install jentic and call await client.execute(ExecutionRequest(...)).

Does Blueshift support GDPR data subject requests?

Yes. POST /api/v1/customers/delete hard-deletes a customer record, POST /api/v1/customers/forget anonymises while preserving aggregates, and POST /api/v1/customers/merge consolidates duplicates. These cover the common right-to-be-forgotten and right-to-rectification flows.

Is the Blueshift API free?

API access is included with a Blueshift subscription — there is no separate API fee. Pricing depends on monthly tracked users and channel volume; demos and sandbox access are available on request.

Blueshift API

Connect the Blueshift API to your agent

Capabilities

Start building with Blueshift API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs