Skip to content

OpenBack API V3

OpenBack Enterprise API for Smart Notifications

Version: 1.0

Security


apiKeyHeader

apiKey API Key
Name Ocp-Apim-Subscription-Key
In header

apiKeyQuery

apiKey API Key
Name subscription-key
In query

Campaign

createBatchCampaign


Method Type: POST

Endpoint URL: /v3/campaign/createBatchCampaign

Description: Create a batch campaign for individual users from existing campaign templates

Parameters

Name Located in Description Required Schema
campaignBatchDto body No CampaignBatchDto

Responses

Code Description Schema
200 OK BasicResponseDto
400 BadRequest BasicResponseDto
401 Unauthorized BasicResponseDto
403 Forbidden BasicResponseDto

get


Method Type: GET

Endpoint URL: /v3/campaign/get

Description: Get Campign Details By Client Campaign Ref Id

Parameters

Name Located in Description Required Schema
clientKey query OpenBack Client Key Yes string
clientId query Format - int64. Client ID Yes integer
clientCampaignRefId query Format - int64. Client Campaign Reference ID Yes integer

Responses

Code Description Schema
200 OK CampaignResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

getByAppCode


Method Type: GET

Endpoint URL: /v3/campaign/getByAppCode

Description: Get list of campaigns by App Code

Parameters

Name Located in Description Required Schema
clientKey query OpenBack API Key Yes string
clientId query Format - int64. Client ID Yes integer
appCode query App Code Yes string

Responses

Code Description Schema
200 OK CampaignResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

update


Method Type: POST

Endpoint URL: /v3/campaign/update

Description: Update existing campaign details

Parameters

Name Located in Description Required Schema
campaignDetailsDto body CampaignDetailsDto No CampaignDetailsDto

Responses

Code Description Schema
200 OK BasicResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

create


Method Type: POST

Endpoint URL: /v3/campaign/create

Description: Create campaign details

Parameters

Name Located in Description Required Schema
campaignDetailsDto body Campaign Details DTO No CampaignDetailsDto

Responses

Code Description Schema
200 OK BasicResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

Group

get


Method Type: GET

Endpoint URL: /v3/group/get

Description: Get Group By Group Ref ID

Parameters

Name Located in Description Required Schema
clientKey query Client Key Yes string
clientId query Format - int64. Client ID Yes integer
groupRefId query Format - int64. Group Ref Id Yes integer

Responses

Code Description Schema
200 OK GroupResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

getByAppCode


Method Type: GET

Endpoint URL: /v3/group/getByAppCode

Description: Get all groups details by app cod

Parameters

Name Located in Description Required Schema
clientKey query OpenBack Client Key Yes string
clientId query Format - int64. Client ID Yes integer
appCode query Unique App Code Yes string

Responses

Code Description Schema
200 OK GroupResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

create


Method Type: POST

Endpoint URL: /v3/group/create

Description: Create a group.

Parameters

Name Located in Description Required Schema
groupInfoDto body group No GroupInfoDto

Responses

Code Description Schema
200 OK BasicResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

update


Method Type: POST

Endpoint URL: /v3/group/update

Description: Update group details

Parameters

Name Located in Description Required Schema
groupInfoDto body Group Details No GroupInfoDto

Responses

Code Description Schema
200 OK BasicResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

Report

getCampaignsByClientId


Method Type: POST

Endpoint URL: /v3/report/getCampaignsByClientId

Description: Get All Campaign Summary Reports By Client ID

Parameters

Name Located in Description Required Schema
reportRequestDto body ReportRequestDto No ReportRequestDto

Responses

Code Description Schema
200 OK CampaignReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

getCampaignsByAppCode


Method Type: POST

Endpoint URL: /v3/report/getCampaignsByAppCode

Description: Get All Campaign Summary Reports from Sdk App Code

Parameters

Name Located in Description Required Schema
reportRequestDto body ReportRequestDto No ReportRequestDto

Responses

Code Description Schema
200 OK CampaignReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

getAppsByClientId


Method Type: POST

Endpoint URL: /v3/report/getAppsByClientId

Description: Get All App Report Details from Client ID

Parameters

Name Located in Description Required Schema
reportRequestDto body ReportRequestDto No ReportRequestDto

Responses

Code Description Schema
200 OK CampaignReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

getAppByAppCode


Method Type: POST

Endpoint URL: /v3/report/getAppByAppCode

Description: Get All App Report Details from Sdk AppCode

Parameters

Name Located in Description Required Schema
reportRequestDto body ReportRequestDto No ReportRequestDto

Responses

Code Description Schema
200 OK AppReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

getCampaignByGroupRefId


Method Type: POST

Endpoint URL: /v3/report/getCampaignByGroupRefId

Description: Get a Campaign Summary Report from Group Ref ID

Parameters

Name Located in Description Required Schema
reportRequestDto body Report Request DTO No ReportRequestDto

Responses

Code Description Schema
200 OK CampaignReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

getCampaignByClientCampaignRefId


Method Type: POST

Endpoint URL: /v3/report/getCampaignByClientCampaignRefId

Description: Get a Campaign Summary Report by Client Campaign Ref ID

Parameters

Name Located in Description Required Schema
reportRequestDto body Report Request DTO No ReportRequestDto

Responses

Code Description Schema
200 OK CampaignReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

getGoalByGoalCode


Method Type: POST

Endpoint URL: /v3/report/getGoalByGoalCode

Description: Get a Goal Summary Report by Goal Code

Parameters

Name Located in Description Required Schema
reportRequestDto body Report Request DTO No ReportRequestDto

Responses

Code Description Schema
200 OK GoalReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

getTrackingIds


Method Type: GET

Endpoint URL: /v3/report/getTrackingIds

Description: /report/getTrackingIds

Parameters

Name Located in Description Required Schema
clientKey query Client Key Yes string
clientId query Format - int64. Client Id Yes integer
sdkAppCode query App Code Yes string

Responses

Code Description Schema
200 OK TrackingIdResponseDto
400 BadRequest BasicResponseDto
401 Unauthorized BasicResponseDto
403 Forbidden BasicResponseDto

User

gdprRemoveUserRequests


Method Type: POST

Endpoint URL: /v3/user/gdprRemoveUserRequests

Description: Method to process GDPR user requests to remove their records

Parameters

Name Located in Description Required Schema
gdprRequestDto body No GdprRequestDto

Responses

Code Description Schema
200 OK BasicResponseDto
400 BadRequest BasicResponseDto
401 Unauthorized BasicResponseDto
403 Forbidden BasicResponseDto