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

Blueshift REST API

The Blueshift REST API: 81 operations across 21 resource groups covering customer profiles and privacy operations (create/update, bulk, merge, forget/unforget, delete), event ingestion (single, bulk, summary, history, debug), product and content catalogs, segments and segment membership counts, custom user lists, campaign lifecycle (create, schedule, launch, pause, archive, trigger, bulk trigger) and campaign reporting, email/push/SMS templates and test sends, shared assets, external fetch templates, promotions, interest alerts, subscription groups, iOS Live Activities, adapters, tags and email validation. HTTP Basic authentication with an API key as the username and an empty password; two key classes (Event API key and User API key) split the surface.

This API exposes 81 operations across 72 paths, organized into 21 resource areas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.getblueshift.com, https://api.eu.getblueshift.com.

81 operations 72 paths 0 schemas 2 DELETE31 GET3 PATCH28 POST17 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.getblueshift.com
Authentication
HTTP Basic, HTTP Basic
Resource Areas
21

Authentication & Security 2

Blueshift REST API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (user_api_auth). It accepts HTTP basic authentication (event_api_auth).

Paths & Operations 81

Across 72 paths, the API surfaces 81 operations — 2 DELETE, 31 GET, 3 PATCH, 28 POST, 17 PUT. They span 21 resource areas, including Adapters, Event, Campaigns, Catalog, Custom user lists, Customer, Customer groups, Search, and 13 more. Each is listed below with its method, path, parameters, and response codes.

Adapters 1

Adapters are entities that provide integration to various services with Blueshift. For example, we provide adapters for various services such as Mailgun, Sendgrid, and Sparkpost f…

GET
/api/v1/account_adapters
List adapters
2 params → 200400401403404409413422
Event 6

Use the event APIs to send events from your servers.

POST
/api/v1/bulkevents
Send bulk events
body → 200400401403404413422429
GET
/api/v1/data_connectors/{data_connector_uuid}/debug
Debug event exports
1 param → 200400401403404422429500
POST
/api/v1/event
Send an event
body → 200400401403404413422429
GET
/api/v1/event/debug
Most recent event
→ 200400401403404422429500
GET
/api/v1/event/history
Get event history
2 params → 200400401403404422429500
POST
/api/v1/event/summary.json
Summary of events
2 params → 200400401403404422429500
Campaigns 15

Manage your campaigns in Blueshift.

GET
/api/v1/campaigns.json
Performance summary
4 params → 200400401403404422429500
PUT
/api/v1/campaigns/bulk_archive
Bulk archive campaigns
body → 200400401403404422429500
POST
/api/v1/campaigns/bulk_execute
Bulk trigger campaigns
body → 200400401403404422429500
PUT
/api/v1/campaigns/bulk_unarchive
Bulk unarchive campaigns
body → 200400401403404422429500
POST
/api/v1/campaigns/execute
Trigger a campaign
body → 200400401403404422429500
POST
/api/v1/campaigns/{campaign_type}
Create a campaign
1 param body → 200400401403404422429500
GET
/api/v1/campaigns/{campaign_uuid}.json
Detailed report without stats
1 param → 200400401403404422429500
PUT
/api/v1/campaigns/{campaign_uuid}/archive
Archive a single campaign
1 param → 200400401403404422429500
GET
/api/v1/campaigns/{campaign_uuid}/detail.json
Detailed report with stats
3 params → 200400401403404422429500
PATCH
/api/v1/campaigns/{campaign_uuid}/launch
Launch a campaign
1 param body → 200400401403404422429500
PATCH
/api/v1/campaigns/{campaign_uuid}/pause
Pause a campaign
1 param body → 200400401403404422429500
PUT
/api/v1/campaigns/{campaign_uuid}/unarchive
Unarchive a single campaign
1 param → 200400401403404422429500
PATCH
/api/v1/campaigns/{campaign_uuid}/update_schedule
Update campaign schedule
1 param body → 200400401403404422429500
GET
/api/v2/campaigns.json
List campaigns
10 params → 200400401403404422429500
GET
/api/v2/customer_campaign_activity
Get a customer's campaign activity
7 params → 200400401403404429500502
Catalog 4

A catalog is a list of items which may include content or products.

GET
/api/v1/catalogs
Get list of catalogs
→ 200400401403404409413422
POST
/api/v1/catalogs
Create a catalog
body → 200400401403404422429500
GET
/api/v1/catalogs/{catalog_uuid}.json
Get catalog details
1 param → 200400401403404413422429
PUT
/api/v1/catalogs/{catalog_uuid}.json
Add items to a catalog
2 params body → 200400401404413422429500
Custom user lists 8

A custom user list contains information about the users of your site such as name, email, phone number, and location. You can use this list as a segment and run campaigns for them.

PUT
/api/v1/custom_user_lists/add_user_to_list/{list_id}
Add user to list
1 param body → 200400401403404409422429
PUT
/api/v1/custom_user_lists/bulk_add_users_to_list/{list_id}
Bulk add users to list
2 params body → 200400401403404413422429
PUT
/api/v1/custom_user_lists/bulk_remove_users_from_list/{list_id}
Bulk remove users from list
2 params body → 200400401403404413422429
POST
/api/v1/custom_user_lists/create
Create empty list
body → 200400401403404409422429
GET
/api/v1/custom_user_lists/id/{custom_user_list_id}
Get customer list details
1 param → 200400401403404409422429
PUT
/api/v1/custom_user_lists/overwrite_list/{list_id}
Overwrite users in a list
1 param body → 200400401403404409422429
PUT
/api/v1/custom_user_lists/remove_user_from_list/{list_id}
Remove user from list
1 param body → 200400401403404409422429
GET
/api/v1/custom_user_lists/seed_lists
Get seed lists from your account
→ 200400401403404409422429
Customer 9

Blueshift hosts 360 degree customer profile for each of your users to represent all of their demographic, behavioral and engagement activity.

POST
/api/v1/customer_attributes/trigger_import
Trigger customer import
body → 200401404405429500502503
GET
/api/v1/customers
Search customer
1 param → 200400401403404409413422
POST
/api/v1/customers
Create or update customer
body → 200400401403404409413422
POST
/api/v1/customers/bulk
Bulk create/update customer
body → 200400401403404409413422
POST
/api/v1/customers/delete
Delete a customer
1 param body → 200400401403404409413422
POST
/api/v1/customers/forget
Stop tracking a customer
body → 200400401403404409413422
POST
/api/v1/customers/merge
Merge customers
body → 200400401403404409413422
POST
/api/v1/customers/unforget
Start tracking a customer
body → 200400401403404409413422
GET
/api/v1/customers/{uuid}
Get customer
1 param → 200400401403404409413422
Customer groups 2

Customer groups link multiple customer profiles to a common parent entity with shared attributes. Use these endpoints to delete a group or remove a user from a group.

DELETE
/api/v1/customer_group/{group_id}
Delete customer group
2 params → 200400401403404429500502
DELETE
/api/v1/customer_group/{group_id}/user/{user_uuid}
Remove user from customer group
2 params → 200400401403404429500502
Search 1

You can use the customersearch API to search for events associated with a customer.

GET
/api/v1/customer_search/show_events
Get customer events
1 param → 200400401403404409422429
Email template 5

Email template lifecycle management

GET
/api/v1/email_templates.json
List email templates
5 params → 200400401403404422429500
POST
/api/v1/email_templates.json
Create email template
body → 200400401403404422429500
POST
/api/v1/email_templates/test_send.json
Send a test mail
body → 200400401403404422429500
GET
/api/v1/email_templates/{TEMPLATE_UUID}.json
Get template details
1 param → 200400401403404422429500
PUT
/api/v1/email_templates/{TEMPLATE_UUID}.json
Update email template
1 param body → 200400401403404422429500
Email validation 2

Validate single or bulk email addresses to assess deliverability and risk.

POST
/api/v1/emails/bulk_validate
Validate multiple email addresses
body → 200400401403404413429500
GET
/api/v1/emails/validate
Validate a single email address
1 param → 200400401403404413429500
External fetch 3

External fetch is a Blueshift capability that lets you include dynamic content from external servers that is fetched “just in time” before sending a message.

GET
/api/v1/external_fetches.json
List external fetch templates
2 params → 200400401403404422429500
POST
/api/v1/external_fetches.json
Create an external fetch template
body → 200400401403404422429500
PUT
/api/v1/external_fetches/{template_uuid}
Update an external fetch template
1 param body → 200400401403404422429500
Interest alerts 2

Interest alerts store information about users' interests. When an event occurs in an area or topic in which multiple users are interested, you can trigger a single API call to sen…

POST
/api/v1/interests/alert
Update or alert customers
body → 200400401403404422429500
GET
/api/v1/interests/user_subscriptions
Get customer subscriptions
5 params → 200400401403404422429500
Live Activities 2
POST
/api/v1/live_activity/start
Start a Live Activity
body → 200400401403404413422429
POST
/api/v1/live_activity/update
Update a Live Activity
body → 200400401403404413422429
Live content 2

Use the Live content API endpoint to insert content recommendations in your website and mobile apps.

GET
/api/v1/onsite_slots.json
List live content slots
3 params → 200400401403404422429500
POST
/live
Live content
body → 200400401403404422429500
Promotions 2

Promotions allows you to manage promo codes that you may wish to send to your customers through Blueshift Campaigns

PUT
/api/v1/promotions/{promotion_uuid}/add_promocodes
Add promo codes to promotion
1 param body → 200400401403404409422429
PUT
/api/v1/promotions/{promotion_uuid}/overwrite
Overwrite promo codes in promotion
1 param body → 200400401403404409422429
Push template 4

Push template lifecycle management

GET
/api/v1/push_templates.json
List push templates
4 params → 200400401403404422429500
POST
/api/v1/push_templates.json
Create a push template
body → 200400401403404422429500
POST
/api/v1/push_templates/test_push.json
Push a test message
body → 200400401403404422429500
PUT
/api/v1/push_templates/{template_uuid}
Update a push template
1 param body → 200400401403404422429500
Segments 2

A segment is a list of users that satisfy a criteria. For example, you can create a segment for users who are located in the San Francisco area and run campaigns for them.

GET
/api/v1/segments/list
Get list of segments
4 params → 200400401403404409422429
GET
/api/v1/segments/{segment_uuid}/matching_users.json
Get segment membership counts
4 params → 200400401403404409422429
Shared assets 3

Manage reusable assets such as HTML, rich text, subject lines, and visual editor content.

GET
/api/v1/shared_assets.json
List shared assets
5 params → 200400401403404409413422
POST
/api/v1/shared_assets.json
Create a shared asset
body → 200401422500
PUT
/api/v1/shared_assets/{uuid}.json
Update a shared asset
1 param body → 200401404422500
SMS template 4

SMS template lifecycle management

GET
/api/v1/sms_templates.json
List SMS templates
5 params → 200400401403404409422429
POST
/api/v1/sms_templates.json
Create an SMS template
body → 200400401403404409422429
POST
/api/v1/sms_templates/test_send.json
Send a test SMS
body → 200400401403404422429500
PUT
/api/v1/sms_templates/{template_uuid}
Update an SMS template
1 param body → 200400401403404409422429
Subscription groups 3

Retrieve subscription groups and view detailed information for each subscription group.

GET
/api/v1/subscription_groups
List subscription groups
→ 200401404429500502503504
GET
/api/v1/subscription_groups/index_lite
List subscription groups (lite)
→ 200401404429500502503504
GET
/api/v1/subscription_groups/{uuid}
Get a subscription group
1 param → 200401404429500502503504
Tags 1

Tags are folder-based entities that you can use to organize your resources. Each tag folder contains its own isolated set of tags.

GET
/api/v1/tag_contexts/list
List tags and tag folders
2 params → 200400401403404409413422

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

blueshift-openapi.yml Raw ↑
Where this information came from

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