Help Center

Guide for Migration from BlueConic API v1 to v2

The purpose of this guide is to help BlueConic users prepare to migrate their applications from the BlueConic REST API v1 to BlueConic REST API v2 following the July 2023 release. Where needed, it provides information on using OAuth 2.0 to authorize BlueConic apps.

Applications or services integrated with the REST API v1 that use authentication

Set up your API access following the documentation for Access management via OAuth 2.0.

Identify which endpoints you are currently using from the current API v1 and correlate them to endpoints you will need to migrate to when using our REST API v2. See the mapping guide below. Note especially the v1 endpoints that have been removed from REST API v2.

Update any status code responses that have changed.

Applications or services integrated with the REST API v1 that do not require authentication

Update any status code responses that have changed.

Endpoints used in REST API v1 and removed from REST API v2

Here is a list of endpoints present in the public BlueConic REST API v1, that are no longer available in the public REST API v2:

```
PUT /rest/profiles/bulk
```
- Superseded by profile bulk API.
```
PUT /rest/profiles/<id>
```
- Replaces a profile with another profile.
- Not currently available, but contact your BlueConic Customer Success Manager if you require this.
```
POST /rest/profiles
```
- Superseded by profile bulk API.
```
PUT /rest/profiles/<id>/legislation
```
- Superseded by profile bulk API.
```
PUT /rest/profiles/<id>/permissions
```
- Not currently available, but contact your BlueConic Customer Success Manager if you require this.
```
PUT /rest/profiles/<id>/permissions/exceptions/
```
- Not currently available, but contact your BlueConic Customer Success Manager if you require this.
```
DELETE /rest/profiles/<id>
```
- Superseded by profile bulk API.
All Objectives methods
- Superseded by profile bulk API.

Endpoint Mapping Tables from REST API v1 to REST API v2

The following tables provide basic information mapping the functionality of API endpoints from the BlueConic REST API v1 to v2. Some endpoints have changed parameters, and the response will be different. For this reason, it is important to check the full API documentation.

Base REST URL

v1	v2
https://yourserver.blueconic.net/rest	https://yourserver.blueconic.net/rest/v2

Old REST API v1 endpoint to migrate from	v1 request type	v1 endpoint type	New public REST API v2 endpoint to migrate to	Documentation	Available as of
PROFILE METHODS
/rest/profiles	Get Profiles	Public	/rest/v2/profiles	Link	Q3-2023
/rest/profiles	Update Profile	Public	/rest/v2/profiles	Link	Q3-2023
/rest/profiles	Update Profiles	Public	/rest/v2/profiles	Link	Q3-2023
/rest/profiles	Delete Profile	Private	/rest/v2/profiles	Link	Q3-2023
/rest/profiles	Get Timeline Events	Private	/rest/v2/profiles/{profileId}	Link	Q3-2023
/rest/profiles	Create Profile	Private	/rest/v2/profiles	Link	Q3-2023
/rest/profiles	Delete Profiles JSON Body	Private	/rest/v2/profiles	Link	Q3-2023
INTERACTION METHODS
/rest/interactions	Get Interactions	Public	/rest/v2/interactions	Link	Q3-2023
/rest/pageviewEvents	Create Pageview Event	Private	/rest/v2/pageviewEvents	Link	Q3-2023
/rest/interactionEvents	Create Interaction Event	Private	/rest/v2/interactionEvents	Link	Q3-2023
DOMAIN METHODS (CHANNELS, POSITIONS)
/rest/domains	Get Domains	Private	/rest/v2/channels	Link	Q3-2023
/rest/domains	Get Domain	Private	/rest/v2/channels/{channelId}	Link	Q3-2023
PROFILE PROPERTY METHODS
/rest/profileProperties	Get Profile Properties	Public	/rest/v2/profileProperties	Link	Q3-2023
/rest/profileProperties	Get Profile Property	Public	/rest/v2/profileProperties/{profilePropertyId}	Link	Q3-2023
/rest/profileProperties	Delete Profile Property	Public	/rest/v2/profileProperties/{profilePropertyId}	Link	Q3-2023
/rest/profileProperties	Create or Update Profile Property	Private	/rest/v2/profileProperties/{profilePropertyId}	Link	Q3-2023
/rest/profileProperties	Delete Profile Property	Private	/rest/v2/profileProperties/{profilePropertyId}	Link	Q3-2023
SEGMENT METHODS
/rest/segments	Get Segments	Public	/rest/v2/segments	Link	Q3-2023
/rest/segments	Get Segment	Public	/rest/v2/segments	Link	Q3-2023
/rest/segments	Get Segment	Private	/rest/v2/segments	Link	Q3-2023
GENERATE RECOMMENDATIONS
/rest/recommendations	Get Recommendations	Public	/rest/v2/recommendations	Link	Q3-2023
AUDIT EVENTS
/rest/auditEvents	Get Audit Events	Public	/rest/v2/auditEvents	Link	Q3-2023
GROUP METHODS
/rest/groups	Update Group	Public	/rest/v2/profiles	Link	Q3-2023
/rest/groups	Update Group Async	Private	/rest/v2/groups	Link	Q3-2023