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.
All domain/channel endpoints
- Not currently available, but contact your BlueConic Customer Success Manager if you require this.

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. This is meant to serve as a starting point and may not have all endpoints listed.

Base REST URL

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

Note:

For the rest of this guide, we will include /v2/ with the endpoints to keep clear the version. Also note that unless otherwise stated, the endpoints for all operations (GET, PUT, etc.) are the same. The tables are ordered based on our v1 documentation, starting with Profile methods.

Profile methods

v1	v2
/profiles/[profile]	/v2/profiles/[profileId]

Profile event methods

v1	v2
/profiles/profileEvents/[profile]	/v2/profiles/profileEvents/[profileId]

Interaction methods

v1	v2
/interactions	/v2/interactions
/pageviewEvents	/v2/pageviewEvents
/interactionEvents	/v2/interactionEvents

URL mapping methods

v1	v2
/urlmappings	/v2/urlmappings
/urlmappings/[urlmapping]	/v2/urlmappings/[id]

Domain methods (includes channels, positions)

v1	v2
/domains/[profile]	Not available in v2

Profile property methods

v1	v2
/profileProperties	/v2/profileProperties
/profileProperties/[id]	/v2/profileProperties/[profilePropertyId]

Segment methods

v1	v2
/segments	/v2/segments
/segments/[id]/profiles	/v2/segments/[segmentID]/profiles

Generate recommendations

v1	v2
/recommendations	/v2/recommendations

Audit events

v1	v2
/auditEvents	/v2/auditEvents