Jump to Content
Home
Guides
API Reference
API Reference
Log In
Jump to Content
Home
Guides
API Reference
Performs a login with username and password
Search
Log In
All
Pages
Start typing to search…
JUMP TO
Getting Started - BETA
My Requests
Account
Core
Get the specific account
get
Create a new account
post
Delete anonymous account
del
aggregated view of the specified account
get
merge an account into an other account
put
Get Balanceinformations for the account
get
Get Balanceinformations for the account. Returned points are displayed as EUR
get
Get Statusinformations for the account
get
Get rating level for the account
get
Update rating level for the account
put
Delete rating level for the account
del
Get the fraudInfo for the account
get
Create the Fraud and lock account
post
Remove the Fraud and unlock account
del
Identifiers
Get identifiers for the account
get
Create a new Identifier
post
Locks an Identifier
post
Unlocks an Identifier
post
Memberships
Get membership for the account
get
Create a new Membership
post
Update Membership
patch
remove Membership
del
Get memberships for the account
get
update Membership Optins
patch
Bookings
Create a new Booking
post
Get bookings for the account
get
Get levelBookings for the account
get
Create a new LevelBooking
post
Deprecated
Create a new LevelBooking
post
Create a new Booking
post
Coupons
Get all account coupons for the specified user
get
Get all coupon redemptions for account
get
Transactions
Get transactions for the account
get
Create a new Transaction
post
Create a preview of a Transaction
post
Incentivate an existing Transaction
patch
Deprecated
Get transactions for the account
get
Coupon
Core
Get coupon by id
get
Create a new coupon
post
Update existing coupon
put
Deletes a coupon
del
Get all coupons for the specified query params
get
Update existing coupon status
patch
Verifies external reference
get
Deprecated
Create a new coupon
post
Deletes a coupon
del
Get all coupons for the specified query params
get
Update existing coupon
put
Account Assignation
Get accounts assigned to this coupon
get
Assigns an account to this coupon
post
Unassign account from coupon
del
Get number of accounts assigned to a coupon
get
Get details about account assignation for this coupon
get
Account Assignation Batch
Returns a list of batch assignation operations
get
Assigns a list of accounts to a coupon
post
Assigns a list of accounts to a coupon
post
Abort batch assignation
post
Get details of coupon batch assignation, allows limiting the number of error messages to include
get
Paginate error messages within a batch
get
Get amount of Accounts related to an array of Coupons
post
Deprecated
Get details of coupon batch assignation
get
Assigns a list of accounts to a coupon
post
Returns a list of batch assignation operations
get
Returns a list of batch assignation operations
get
PromoCode
Get all generics codes created for promocodes
get
Create a generic promo code
post
Deletes a generic code of a coupon
del
Get all unique individual codes created for promocodes
get
Create an unique individual codes of promo codes
post
Create an unique individual of promo codes
post
Deletes a unique promo code of a coupon
del
Account coupon & Promo code
Get AccountCoupon/PromoCode details depending on the request
get
Redeem for the AccountCoupon or Promo-codes depending on id-type value.
patch
Get the couponcode for the specified AccountCoupon
get
activate or deactivate the AccountCoupon
patch
Previews the redeem for the AccountCoupon or Promo-codes depending on id-type value.
patch
Cancels a coupon redemption using the redemptionId
del
Deprecated
redeem the AccountCoupon
patch
redeem the AccountCoupon
put
Get the couponcode for the specified AccountCoupon
get
Get the couponcode for the specified AccountCoupon
get
Get the accountcoupon details
get
Previews the redeem for the AccountCoupon
patch
redeem the AccountCoupon
patch
Previews the redeem for the AccountCoupon
put
redeem the AccountCoupon
put
Images
Upload an image for the specified coupon
post
Deletes an specific image which is related to the specified coupon
del
Deprecated
Upload an image for the specified coupon
post
Transaction
Core
Get retail transaction
get
Create a new Transaction preview
post
Book revenue transaction
post
Get retail transactions
get
Program
Blacklists
Get blacklisted item for a program
get
Create a blacklisted item for a program
post
Update a blacklisted item for a program
put
Delete a blacklisted item for a program
del
Get all blacklisted items for a program
get
Custom Properties
Get one custom property for a program
get
Create a custom property for the specified program
post
Update a custom property for the specified program
put
Get all custom properties for the specified program
get
Endpoint
Get the endpoint for the specified id and the specified program
get
Create an endpoint for the specified program
post
Changes the endpoint with the given id
put
Deletes the endpoint with the given id
del
Get all endpoints for the specified program. Can be filtered by type.
get
Deprecated
Create an endpoint for the specified program
post
Changes the endpoint with the given id
put
Product Catalog
Partner & Stores
Get all groups of the specified partner
get
Create a new group for a partner
post
Get the subgroup for the specified ID and program
get
Create subgroup for the specified partner and group
post
Get all subgroups of the specified partner and group
get
Get all items of the specified partner
get
Create item for the specified partner/group/subgroup
post
Get all items of the specified partner/group/subgroup
get
Groups
Get the group for the specified ID
get
Create a new group for program
post
Changes the group with the specified ID
put
Deletes the group with the specified ID
del
Get program groups
get
Subgroups
Get program subgroups
get
Create subgroup for the specified program and group
post
Changes the subgroup with the specified ID
put
Deletes the subgroup with the specified ID
del
Get subgroups of the specified group
get
Items
Get the item for the specified ID
get
Create item for the specified program/group/subgroup
post
Changes the item with specified ID
put
Deletes the item with specified ID
del
Get the items of the specified group and subgroup
get
Get program items
get
Deprecated
Changes the subgroup with the specified ID
put
Get program subgroups
get
Create item for the specified partner/group/subgroup
post
Create subgroup for the specified partner and group
post
Create a new group for a partner
post
Changes the item with specified ID
put
Get program items
get
Create item for the specified program/group/subgroup
post
Create subgroup for the specified program and group
post
Changes the group with the specified ID
put
Create a new group for program
post
Get program groups
get
Interaction Points
Core
Get the interaction points for the specified id
get
Create a new Interaction Point for a program
post
Updates the interaction point with the given id
patch
Deletes the interaction point with the given id
del
Get the interaction points for the specified program
get
Get the interaction points details for the specified id. The detailed object resolves the referenced businessUnitId.
get
Partners & Stores
Get the interaction points for the specified partner
get
Create a new Interaction Point for a partner
post
Get the interaction points for the specified id
get
Get the interaction points for the specified store
get
Create a new Interaction Point for a store
post
Get the interaction points for the specified id
get
Deprecated
Create a new Interaction Point for a program
post
Create a new Interaction Point for a partner
post
Create a new interaction point
post
Operations
Get API operations for a program
get
Partners
Get the partner for the specified id and the specified program
get
Create a new partner
post
Changes a partner for the specified program
put
Deactivates a partner for the specified program
del
Get all partners for the specified program
get
Get all affiliate partners for the specified partner
get
Get all affiliate programUnits for the specified partner
get
Deprecated
Get all partners for the specified program
get
Changes a partner for the specified program
put
Deactivates a partner for the specified program
del
Create a new partner
post
Get all partners for the specified program
get
Stores
Get the store for the specified id and the specified partner
get
Create a new store
post
Changes a store for the specified program
put
Deactivates a store for the specified program
del
Get all stores for the specified program
get
Get all stores for the specified program
get
Deprecated
Create a new store
post
Changes a store for the specified program
put
Get all stores for the specified partner
get
Get all stores for the specified program with pagination
get
Get all stores for the specified partner with pagination
get
Get all stores for the specified program
get
Partner Blacklists
Get all blacklisted items for a partner
get
Create a blacklisted item for a partner
post
Get blacklisted item for a partner
get
Update a blacklisted item for a partner
put
Delete a blacklisted item for a partner
del
Rating
Config
Get rating config for program
get
Get rating config for partner
get
Create/update the rating config for a partner
put
Levels
Get rating levels for program
get
Get a rating level for program
get
Status Level
Get a specific status level set.
get
Update a specific status level set
put
Delete a specific status level set
del
Get all StatusLevelSets for the specified program. Can be filtered by status of the set
get
Get all StatusLevelSets for the specified program. Can be filtered by status of the set
post
Resources
Get a resource
get
Create a resource
post
Delete a resource
del
Tag
Create a tag for the specified program
post
Changes a tag for the specified program
put
Delete the specified tag for the specified program
del
Get all tags for the specified program. Can be filtered by domain
get
Get the custom property for the specified id and the specified program
get
Deprecated
Create a tag for the specified program
post
Changes a tag for the specified program
put
Events
Get all events for the specified membership
get
Connectors
Core
/connectors/ping
get
/connectors/{connectorId}/{domainId}
post
/connectors/{connectorId}/{domainId}/api/v2/sales
post
Health
get
get
Webhook
Actions
Core
Retrieve a single Action
get
Retrieve multiple Actions
get
/webhooks/action/retry/{actionId}
post
Config
Retrieve a single ActionConfig
get
Create a single ActionConfig
post
Replace a single ActionConfig
put
Update a single ActionConfig
patch
Delete a single ActionConfig
del
Retrieve multiple ActionConfigs
get
/webhooks/action-config/{id}/resume
post
/webhooks/action-config/{id}/pause
post
/webhooks/action-config/{id}/empty
post
/webhooks/action-config/{id}/retry
post
History
Retrieve a single History
get
Retrieve multiple Histories
get
Events
Retrieve a single Event
get
Retrieve multiple Events
get
Domain Type
/webhooks/domain-type
get
Integration
/webhooks/integration/convercus-analytics
post
/webhooks/integration/convercus-analytics/{alias}
put
/webhooks/integration/concercus-analytics/{alias}
del
Operations
/webhooks/operations
get
Newsfeed
Core
Get Newsfeed
get
Get Newsfeed Item
get
Create Newsfeed Message
post
Deprecated
/newsfeed-service/newsfeeds
get
/newsfeed-service/v2/newsfeeds/{newsFeedItemId}
get
Post
Get post
get
Create post
post
Update post
patch
Delete post
del
List posts
get
Schedule post
post
Schedule post deletion
patch
Publish post
post
Clone post
post
Deprecated
/newsfeed-service/posts/{postId}
patch
/newsfeed-service/posts
post
/newsfeed-service/posts/{postId}
patch
/newsfeed-service/posts
post
Post Assignment
Assign account
post
Update assignment
put
Unassign account
del
Assign accounts (batch)
post
Unassign accounts (batch)
del
Deprecated
/newsfeed-service/posts/{postId}/accounts/batch
put
/newsfeed-service/posts/{postId}/accounts/batch
del
/newsfeed-service/posts/{postId}/accounts/{accountId}
put
/newsfeed-service/posts/{postId}/accounts/{accountId}
del
Target Audience
List audiences
get
Create audience
post
Get audience
get
Update audience
patch
Delete audience
del
Audience accounts
post
Validate audience
post
Health
Health check
get
User
Core
Get the user for the specified id
get
Create a new user
post
update user
put
update user
patch
delete user
del
creates a request for resetting a users password
post
update user password
patch
Get the the registration data for the user with the specified id
get
Delete the registration data of the user with the specified id
del
creates a request for resending a notification
post
Add a new custom property for the user
post
Update custom property for the user
put
Delete custom property for the user
del
Deprecated
Create a new user
post
update user
patch
update user
put
Get the the registration data for the user with the specified id
get
Identifier
return the specific Identifier
get
Terminates an Identifier
del
Identifier Batch
list all identifierbatches
get
Performs a new Identifierbatch
post
return the specific IdentifierBatch
get
return all identifiers that belongs to the specific batchId
get
Deprecated
Performs a new Identifierbatch
post
Authentication
Performs a login with username and password
post
Performs a logout of the currently logged in user
del
Events
Get all events for the specified user
get
Push Notification
Notification
List notifications
get
Device count
get
Get notification
get
List targets
get
Targets
Get target
get
Health
Health check
get
get
get
Reports
Account Booking
/reports/v3/account-booking/export
get
Returns a list of accounts bookings
get
Account
/reports/v3/account/export
get
Returns a list of accounts
get
Account Coupon
/reports/v3/account-coupon/export
get
Returns a list of accounts coupons
get
Account Coupon Activations
/reports/v3/account-coupon-activations/export
get
Returns a list of coupon activations
get
Account Level Booking
/reports/v3/account-level-booking/export
get
Returns a list of accounts level bookings
get
Account Snapshot
/reports/v3/account-snapshot/export
get
Returns a list of accounts snapshots
get
Account Status Level
/reports/v3/account-status-level/export
get
Returns a list of accounts status levels
get
Account User
/reports/v3/account-user/export
get
Returns a list of accounts with users
get
Account Identifier
/reports/v3/account-identifier/export
get
Returns a list of accounts identifiers
get
Account Balance
/reports/v3/account-balance/export
get
Returns a list of accounts with users
get
Coupon
/reports/v3/coupon/export
get
Returns a list of coupons
get
Coupon Redemption
/reports/v3/coupon-redemption/export
get
Returns a list of coupon redemptions
get
Membership
/reports/v3/membership/export
get
Returns a list of memberships
get
Partner
/reports/v3/partner/export
get
Returns a list of partners
get
Store
/reports/v3/store/export
get
Returns a list of stores
get
Transaction
/reports/v3/transaction/export
get
Returns a list of transactions
get
User
/reports/v3/user/export
get
Returns a list of users
get
Push Token
/reports/v3/push-tokens/export
get
Returns a list of push tokens
get
InteractionPoint
/reports/v3/interaction-points/export
get
Returns a list of interaction points
get
Segment
Returns a list of segments
get
Score
Returns a list of accounts
get
User App Service
Keycloak
/user-app-service/keycloak/admin/realms/{keycloakRealm}/users/{userId}/organizations
get
Search Service
Search
post
Performs a new search
post
Newsfeed Service
Newsfeed
/newsfeed-service/v2/newsfeeds/{newsFeedItemId}
get
/newsfeed-service/health
get
get
Post
/newsfeed-service/posts
get
/newsfeed-service/posts/{postId}
get
/newsfeed-service/posts/{postId}
del
/newsfeed-service/posts/{postId}/schedule
post
/newsfeed-service/posts/{postId}/schedule/delete
patch
/newsfeed-service/posts/{postId}/publish
post
/newsfeed-service/posts/{postId}/clone
post
Post v2
/newsfeed-service/v2/posts
post
/newsfeed-service/v2/posts/{postId}
patch
Post Assignment
/newsfeed-service/posts/{postId}/accounts/batch
put
/newsfeed-service/posts/{postId}/accounts/batch
del
/newsfeed-service/posts/{postId}/accounts/{accountId}
put
/newsfeed-service/posts/{postId}/accounts/{accountId}
del
Newsfeed
/newsfeed-service/newsfeeds
get
/newsfeed-service/v2/newsfeeds
get
/newsfeed-service/v3/newsfeeds/{newsFeedItemId}
get
/newsfeed-service/v1/newsfeed-messages
post
Post Assignment v2
/newsfeed-service/v2/posts/{postId}/accounts/batch
post
/newsfeed-service/v2/posts/{postId}/accounts/batch
del
Assign Account to Post
post
Update assignation of an account to a newspost
put
/newsfeed-service/v2/posts/{postId}/accounts/{accountId}
del
Target Audience
/newsfeed-service/target-audiences
get
/newsfeed-service/target-audiences
post
/newsfeed-service/target-audiences/{targetAudienceId}
get
/newsfeed-service/target-audiences/{targetAudienceId}
patch
/newsfeed-service/target-audiences/{targetAudienceId}
del
Returns all the associated accounts to the given audience definition
post
Validates if the given audience definition is valid
post
Push Notification service
Operations
List operations
get
Convercus reports
NewsPost
/reports/v3/news-post/export
get
Returns a list of posts
get
AI Service
newsfeed
Generate Content (Async)
post
Generate Image (Async)
post
Health
Health check
get
Prompts
Create a new prompt (brand new prompt only)
post
Get all prompts with optional filtering
get
Get a specific prompt by ID
get
Update an existing prompt
put
Soft delete a prompt
del
Create a new version of an existing prompt
post
Activate a specific version of a prompt
post
Cleanup old prompt versions (utility endpoint)
post
Programs
Create a new program
post
Get all programs with optional filtering
get
Get a specific program by ID
get
Update an existing program
put
Delete a program
del
Assign a prompt to a program for specific service/useCase
post
Resolve a prompt for specific context
get
Get prompt assignment details for a context
get
newsfeed
Get Job Status
get
Device Mounting
/mounting-service/images/upload
post
post
Health
/mounting-service/health
get
Devices
Retrieve multiple Devices
get
Create a single Device
post
Update a single Device
patch
Replace a single Device
put
Delete a single Device
del
Retrieve a single Device
get
Create multiple Devices
post
Mountings
Retrieve multiple Mountings
get
Create a single Mounting
post
Update a single Mounting
patch
Replace a single Mounting
put
Retrieve a single Mounting
get
Delete a single Mounting
del
Create multiple Mountings
post
Profiles
Update a single Profile
patch
Replace a single Profile
put
Retrieve a single Profile
get
Delete a single Profile
del
Retrieve multiple Profiles
get
Create a single Profile
post
Create multiple Profiles
post
Partners
Retrieve multiple Partners
get
Create a single Partner
post
Update a single Partner
patch
Replace a single Partner
put
Retrieve a single Partner
get
Delete a single Partner
del
Create multiple Partners
post
Programs
Retrieve multiple Programs
get
Create a single Program
post
Update a single Program
patch
Replace a single Program
put
Retrieve a single Program
get
Delete a single Program
del
Create multiple Programs
post
Stores
Retrieve multiple Stores
get
Create a single Store
post
Update a single Store
patch
Replace a single Store
put
Retrieve a single Store
get
Delete a single Store
del
Create multiple Stores
post
Images
Retrieve multiple Images
get
Create a single Image
post
Retrieve a single Image
get
Update a single Image
patch
Replace a single Image
put
Delete a single Image
del
Create multiple Images
post
Convercus API
Account Assignation Batch
Update accounts redemption limit
patch
Account Assignation
Update account redemption limit
patch
Tracking service
Health
/tracking-service/health
get
Powered by
Performs a login with username and password
post
https://{environment}.convercus.io/auth/login
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
https://
environment
.convercus.io
/auth/login
RESPONSE
Click
Try It!
to start a request and see the response here!
