Consensus API

Introduction

Base URL:

Hey there 👋! Welcome to the Consensus API. We supply a collection of endpoints that allow you to do some awesome things with your Consensus account and data. Check it out!

If you'd prefer to use our Postman Collection, or download our OpenAPI spec file, please follow the links below:

Click here to download the Postman collection.

Click here to download the OpenAPI spec.

Authenticating requests

In order to authorize, you'll need to pass the following params with each request:

API Key: API Key provided in the ‘Integration->API Credentials’ section on goconsensus.com
API Secret: API Secret provided in the 'Integration->API Credentials' section on goconsensus.com
User Email: Email of the user that inits the request
Source Name: The name of the service from which the request was sent
User Activity: Flag indicating whether to update the last activity field. By default - true.

Example:

"auth": {
    "api_key": "XXXXX...XXX",
    "api_secret": "XXXXX...XXX",
    "user_email": "example@email.domain",
    "source_name": "service name",
    "user_activity": true
}

Finally, you can learn more about retrieving your api key and secret by visiting our knowledge base article Here.

Reports

The reporting endpoints provide bulk data on everything from Consensus Users, to details about DemoBoards, their recipients/viewers and more!

Manage users

POST

/api/reports/v1.0/manageUsers

Returns Consensus User metadata

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

paging

object

resellerFilter

string

Example:

withResellers

Enum:

[withResellers, onlyResellers, withoutResellers]

users

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

groups

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

status

string[]

Example:

["active"]

Enum:

[active, inactive, deleted, other]

Response Fields

data

object

items

object[]

userUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

firstName

string

Example:

John

lastName

string

Example:

Doe

string

Example:

example@email.domain

roles

string

Example:

Admin, Sales

groupUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

groupName

string

Example:

Main group

dateAdded

string

Example:

2023-08-22T08:22:55+0000

lastActivityDateTime

string

Example:

2023-08-22T08:22:55+0000

status

string

Example:

active

Enum:

[active, inactive, deleted, other]

paging

object

countItems

integer

Example:

limit

integer

Example:

500

page

integer

Example:

integer

Example:

integer

Example:

Headers

Body

Received response

Example response :

{
    "data": {
        "items": [
            {
                "userUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "firstName": "John",
                "lastName": "Doe",
                "email": "example@email.domain",
                "roles": "Admin, Sales",
                "groupUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "groupName": "Main group",
                "dateAdded": "2023-08-22T08:22:55+0000",
                "lastActivityDateTime": "2023-08-22T08:22:55+0000",
                "status": "active"
            }
        ],
        "paging": {
            "countItems": 1,
            "limit": 500,
            "page": 1,
            "nextPage": 0,
            "previousPage": 0
        }
    }
}

Demos details

POST

/api/reports/v1.0/demosDetails

Returns Consensus Demo metadata

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

paging

object

type

string[]

Example:

["advanced"]

Enum:

[advanced, single, standard]

uuid

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

start_date

string

Example:

2022-02-24

end_date

string

Example:

2023-09-29

Response Fields

data

object

items

object[]

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

title

string

Example:

internalTitle

string

Example:

description

string

Example:

type

string

Example:

advanced

Enum:

[advanced, single, standard]

isPublic

boolean

Example:

isArchived

boolean

Example:

isPublished

boolean

Example:

createdAt

string

Example:

2023-08-22T08:22:55+0000

hasCmsVideo

boolean

Example:

folderInfo

object

creatorData

object

ownerData

object

mainVideo

object

features

object[]

name

string

Example:

shortVideoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

shortVideoCmsId

string

Example:

1101

shortVideoDuration

string

Example:

413.2

longVideoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

longVideoCmsId

string

Example:

1101

longVideoDuration

string

Example:

413.2

subDemos

object[]

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

title

string

Example:

internalTitle

string

Example:

type

string

Example:

advanced

Enum:

[advanced, single, standard]

mainVideo

object

features

object[]

name

string

Example:

shortVideoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

shortVideoCmsId

string

Example:

1101

shortVideoDuration

string

Example:

413.2

longVideoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

longVideoCmsId

string

Example:

1101

longVideoDuration

string

Example:

413.2

paging

object

countItems

integer

Example:

limit

integer

Example:

500

page

integer

Example:

integer

Example:

integer

Example:

sorting

string[]

Example:

["createdAt"]

Enum:

[createdAt, title, type]

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name" }, "paging": { "limit": 50, "page": 1, "sortBy": "field_name", "order": "ASC" }, "type": [ "advanced" ], "uuid": [ "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" ], "start_date": "2022-02-24", "end_date": "2023-09-29" }

Received response

Example response :

{
    "data": {
        "items": [
            {
                "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "title": null,
                "internalTitle": null,
                "description": null,
                "type": "advanced",
                "isPublic": false,
                "isArchived": false,
                "isPublished": false,
                "createdAt": "2023-08-22T08:22:55+0000",
                "hasCmsVideo": false,
                "folderInfo": {
                    "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "name": null,
                    "path": null
                },
                "creatorData": {
                    "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "email": "example@email.domain",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "ownerData": {
                    "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "email": "example@email.domain",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "mainVideo": {
                    "videoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "videoCmsId": "1101",
                    "duration": "413.2"
                },
                "features": [
                    {
                        "name": null,
                        "shortVideoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "shortVideoCmsId": "1101",
                        "shortVideoDuration": "413.2",
                        "longVideoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "longVideoCmsId": "1101",
                        "longVideoDuration": "413.2"
                    }
                ],
                "subDemos": [
                    {
                        "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "title": null,
                        "internalTitle": null,
                        "type": "advanced",
                        "mainVideo": {
                            "videoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                            "videoCmsId": "1101",
                            "duration": "413.2"
                        },
                        "features": [
                            {
                                "name": null,
                                "shortVideoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                                "shortVideoCmsId": "1101",
                                "shortVideoDuration": "413.2",
                                "longVideoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                                "longVideoCmsId": "1101",
                                "longVideoDuration": "413.2"
                            }
                        ]
                    }
                ]
            }
        ],
        "paging": {
            "countItems": 1,
            "limit": 500,
            "page": 1,
            "nextPage": 0,
            "previousPage": 0
        },
        "sorting": "createdAt"
    }
}

Sales by customer detailed

POST

/api/reports/v1.0/salesByCustomerDetailed

Returns Consensus Sales Demolytics Report Data

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

paging

object

includeDemoBoardData

string[]

Example:

["externalEmailDomains"]

Enum:

[externalEmailDomains, internalEmailDomains, testDemoBoards]

users

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

groups

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

startDate

string

Example:

2022-02-24

endDate

string

Example:

2023-09-29

includeRiv

boolean

Example:

includeSubGroups

boolean

Example:

activityTrack

boolean

Example:

Response Fields

data

object

items

object[]

daysFromLastActivity

integer

Example:

sharesByViewer

integer

Example:

organization

string

Example:

recipient

string

Example:

string

Example:

example@email.domain

createdBy

string

Example:

John

creationSource

string

Example:

creatorEmail

string

Example:

example@email.domain

timeDiff

string

Example:

10:00

demoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

demoTitle

string

Example:

demoCreatorEmail

string

Example:

example@email.domain

dateCreated

string

Example:

2023-08-22T08:22:55+0000

dateInvited

string

Example:

2023-08-22T08:22:55+0000

viewTime

string

Example:

20:00:00

viewDate

string

Example:

2023-09-29

viewLocation

string

Example:

Dalas

invitedBy

string

Example:

John

branchingResponse

string

Example:

subDemoTitle

string

Example:

veryImportantSelected

string

Example:

feature1;feature2

somewhatImportantSelected

string

Example:

feature1;feature2

notImportantSelected

string

Example:

feature1;feature2

paging

object

countItems

integer

Example:

limit

integer

Example:

500

page

integer

Example:

integer

Example:

integer

Example:

Headers

Body

Received response

Example response :

{
    "data": {
        "items": [
            {
                "daysFromLastActivity": 1,
                "sharesByViewer": 1,
                "organization": null,
                "recipient": null,
                "email": "example@email.domain",
                "createdBy": "John",
                "creationSource": "sfdc|outlook|outreach|ios|android|snap|gsnap|zapier|api|webapp",
                "creatorEmail": "example@email.domain",
                "timeDiff": "10:00",
                "demoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "demoTitle": null,
                "demoCreatorEmail": "example@email.domain",
                "dateCreated": "2023-08-22T08:22:55+0000",
                "dateInvited": "2023-08-22T08:22:55+0000",
                "viewTime": "20:00:00",
                "viewDate": "2023-09-29",
                "viewLocation": "Dalas",
                "invitedBy": "John",
                "branchingResponse": null,
                "subDemoTitle": null,
                "veryImportantSelected": "feature1;feature2",
                "somewhatImportantSelected": "feature1;feature2",
                "notImportantSelected": "feature1;feature2"
            }
        ],
        "paging": {
            "countItems": 1,
            "limit": 500,
            "page": 1,
            "nextPage": 0,
            "previousPage": 0
        }
    }
}

Track demo boards

POST

/api/reports/v1.0/trackDemoBoards

Returns Consensus DemoBoard Report Data.

The timeframe within start_date and end_date in request determines the timeframe of the last DemoBoard update. Response returns DemoBoard(s) with the last DemoBoard updated date within the provided timeframe in the request

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

paging

object

demoUuid

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

senddemoUuid

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

senddemoHash

string[]

Example:

["xxxxxxxx"]

inviteUuid

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

inviteHash

string[]

Example:

["xxxxxxxx"]

string[]

Example:

["example@email.domain"]

start_date

string

Example:

2022-02-24

end_date

string

Example:

2023-09-29

externalOpportunityFilter

object

Response Fields

data

object

items

object[]

senddemoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

senddemoHash

string

Example:

xxxxxxxx

isTest

boolean

Example:

demoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

parentDemoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

demoUuids

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

parentDemoUuids

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

demoboardName

string

Example:

organization

string

Example:

viewCount

integer

Example:

viewTime

number

Example:

413.2

ownerUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

ownerName

string

Example:

John

ownerFirstName

string

Example:

John

ownerLastName

string

Example:

Doe

totalHotspotOpened

integer

Example:

totalPageViews

integer

Example:

totalTourViews

integer

Example:

sharedCount

integer

Example:

creationDate

string

Example:

2023-03-08 10:45:58

creationSource

string

Example:

timeLastView

string

Example:

2023-03-08 10:45:58

externalOpportunity

object

invites

object[]

paging

object

countItems

integer

Example:

limit

integer

Example:

500

page

integer

Example:

integer

Example:

integer

Example:

sorting

string[]

Example:

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name" }, "paging": { "limit": 500, "page": 1, "sortBy": "field_name", "order": "ASC" }, "demoUuid": [ "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" ], "senddemoUuid": [ "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" ], "senddemoHash": [ "xxxxxxxx" ], "inviteUuid": [ "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" ], "inviteHash": [ "xxxxxxxx" ], "email": [ "example@email.domain" ], "start_date": "2022-02-24", "end_date": "2023-09-29", "externalOpportunityFilter": { "externalOpportunityAssignment": "ALL" } }

Received response

Example response :

{
    "data": {
        "items": [
            {
                "senddemoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "senddemoHash": "xxxxxxxx",
                "isTest": false,
                "demoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "parentDemoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "demoUuids": [
                    "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"
                ],
                "parentDemoUuids": [
                    "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"
                ],
                "demoboardName": null,
                "organization": null,
                "viewCount": 10,
                "viewTime": 413.2,
                "ownerUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "ownerName": "John",
                "ownerFirstName": "John",
                "ownerLastName": "Doe",
                "totalHotspotOpened": 10,
                "totalPageViews": 10,
                "totalTourViews": 10,
                "sharedCount": 10,
                "creationDate": "2023-03-08 10:45:58",
                "creationSource": "sfdc|outlook|outreach|ios|android|snap|gsnap|zapier|api|webapp",
                "timeLastView": "2023-03-08 10:45:58",
                "externalOpportunity": {
                    "externalOpportunityId": "1101",
                    "externalOpportunityName": null,
                    "externalAccountId": "1101",
                    "externalAccountName": null
                },
                "invites": [
                    {
                        "name": "John",
                        "firstName": "John",
                        "lastName": "Doe",
                        "contactUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "title": null,
                        "primary": null,
                        "inviteUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "inviteStatus": null,
                        "hash": "xxxxxxxx",
                        "email": "example@email.domain",
                        "source": "invite_others|legacy|share|snap|way|integration",
                        "sourceHR": null,
                        "ownerUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "ownerName": "John",
                        "ownerFirstName": "John",
                        "ownerLastName": "Doe",
                        "sharedByUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "sharedByName": "John",
                        "totalHotspotsOpened": 10,
                        "totalPageViews": 10,
                        "totalTourViews": 10,
                        "totalDuration": "413.2",
                        "shares": 0,
                        "views": 0,
                        "viewData": [
                            {
                                "dateView": "2023-03-08 10:45:58",
                                "linkUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                                "viewId": "1101",
                                "selectedDemoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                                "demoTitle": null,
                                "demoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                                "answerIndex": null,
                                "answerName": null,
                                "duration": "413.2",
                                "files": 3,
                                "isReplay": 1,
                                "features": [
                                    {
                                        "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                                        "title": null,
                                        "value": "high"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ],
        "paging": {
            "countItems": 1,
            "limit": 500,
            "page": 1,
            "nextPage": 0,
            "previousPage": 0
        },
        "sorting": null
    }
}

Crm

Update CRM Sync data

Update opportunity data

POST

/api/integr/v1.0/crm/updateOpportunityData

Update CRM Sync Opportunity Data for a DemoBoard

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

request

object

sign

string

Example:

123432423423423432

updatedEntities

object

entityType

string

Example:

CONTACT

Enum:

[CONTACT, ACCOUNT, OPPORTUNITY]

entityAction

string

Example:

CREATE

Enum:

[CREATE, UPDATE, DELETE]

items

object[]

Response Fields

status

integer

Example:

200

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": true }, "request": { "sign": "123432423423423432", "updatedEntities": { "entityType": "CONTACT", "entityAction": "CREATE", "items": [ { "entityId": "1231232132" } ] } } }

Received response

Example response :

{
    "status": 200
}

Demo

This collection lets you work with Demo Data.

Search

POST

/api/integr/v1.0/demo/search

Returns List of demos and related metadata

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

paging

object

limit

integer

Min value 1, max value 500

Example:

100

page

integer

Example:

sortBy

string

Example:

order

string

Example:

asc

Enum:

[asc, desc]

query

string

Example:

my demo

only_valid

boolean

Example:

true

uuid

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

start_date

string

Example:

2018-01-01

end_date

string

Example:

2018-12-31

type

string[]

Example:

["single"]

Enum:

[single, standard, advanced]

include_permissions

boolean

Example:

true

include_thumbs

boolean

Example:

true

include_tours

boolean

Example:

true

include_folderPermissions

boolean

Example:

true

isPublished

boolean

Example:

true

folderUuid

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

responseType

string

Example:

basic

Enum:

[basic, full]

language

string

Example:

Response Fields

data

object

items

object[]

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

uuidType

string

Example:

organization

title

string

Example:

internalTitle

string

Example:

description

string

Example:

type

string

Example:

single

Enum:

[single, standard, advanced]

isPublic

boolean

Example:

true

isArchived

boolean

Example:

true

isPublished

boolean

Example:

true

createdAt

string

Example:

2018-08-22T08:22:55+0000

previewLink

string

Example:

https://play.goconsensus.com/xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx?preview=sales

ownerData

object

creatorData

object

folderInfo

object

highSpot

object

language

object

permissions

object[]

uuid

string

Example:

type

string

Example:

group

Enum:

[group, user]

sharedBelow

boolean

Example:

true

value

string[]

Example:

groupLevel

string

Example:

displayName

string

Example:

previewThumbs

string[]

Example:

["string"]

tours

object[]

folderPermissions

object[]

uuid

string

Example:

type

string

Example:

group

Enum:

[group, user]

sharedBelow

boolean

Example:

true

value

string[]

Example:

groupLevel

string

Example:

displayName

string

Example:

folderUuid

string

Example:

folderName

string

Example:

paging

object[]

countItems

integer

Example:

limit

integer

Example:

page

integer

Example:

integer

Example:

integer

Example:

sorting

string[]

Example:

status

integer

Example:

200

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": true }, "paging": { "limit": 100, "page": 1, "order": "asc" }, "query": "my demo", "only_valid": true, "uuid": [ "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" ], "start_date": "2018-01-01", "end_date": "2018-12-31", "type": [ "single" ], "include_permissions": true, "include_thumbs": true, "include_tours": true, "include_folderPermissions": true, "isPublished": true, "folderUuid": [ "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" ], "responseType": "basic", "language": "en" }

Received response

Example response :

{
    "data": {
        "items": [
            {
                "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "uuidType": "organization",
                "title": null,
                "internalTitle": null,
                "description": null,
                "type": "single",
                "isPublic": true,
                "isArchived": true,
                "isPublished": true,
                "createdAt": "2018-08-22T08:22:55+0000",
                "previewLink": "https://play.goconsensus.com/xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx?preview=sales",
                "ownerData": {
                    "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "email": "example@email.domain",
                    "firstName": "John",
                    "lastName": "Smith"
                },
                "creatorData": {
                    "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "email": "example@email.domain",
                    "firstName": "John",
                    "lastName": "Smith"
                },
                "folderInfo": {
                    "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "name": "Favorite folder"
                },
                "highSpot": {
                    "publishedDate": 1691743777,
                    "isPublished": true
                },
                "language": {
                    "code": "en",
                    "title": "English"
                },
                "permissions": [
                    {
                        "uuid": null,
                        "type": "group",
                        "sharedBelow": true,
                        "value": null,
                        "groupLevel": null,
                        "displayName": null
                    }
                ],
                "previewThumbs": [
                    "string"
                ],
                "tours": [
                    {
                        "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "featureUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "thumbs": {
                            "default": [
                                "string"
                            ]
                        }
                    }
                ],
                "folderPermissions": [
                    {
                        "uuid": null,
                        "type": "group",
                        "sharedBelow": true,
                        "value": null,
                        "groupLevel": null,
                        "displayName": null,
                        "folderUuid": null,
                        "folderName": null
                    }
                ]
            }
        ],
        "paging": [
            {
                "countItems": 0,
                "limit": 0,
                "page": 0,
                "previousPage": 0,
                "nextPage": 0
            }
        ],
        "sorting": null
    },
    "status": 200
}

Get demo by link hash

POST

/api/integr/v1.0/demo/getDemoByLinkHash

Returns demo information

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

hash

string

Example:

xxx...xx

include_permissions

boolean

Example:

true

Response Fields

data

object

demoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

uuidType

string

Example:

organization

demoType

string

Example:

single

title

string

Example:

internalTitle

string

Example:

description

string

Example:

type

string

Example:

single

Enum:

[single, standard, advanced]

isPublic

boolean

Example:

true

isArchived

boolean

Example:

true

creationDate

string

Example:

2018-08-22T08:22:55+0000

linkUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

ownerData

object

permissions

object[]

status

integer

Example:

200

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": true }, "hash": "xxx...xx", "include_permissions": true }

Received response

Example response :

{
    "data": {
        "demoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
        "uuidType": "organization",
        "demoType": "single",
        "title": null,
        "internalTitle": null,
        "description": null,
        "type": "single",
        "isPublic": true,
        "isArchived": true,
        "creationDate": "2018-08-22T08:22:55+0000",
        "linkUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
        "ownerData": {
            "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "email": "example@email.domain",
            "firstName": "John",
            "lastName": "Smith"
        },
        "permissions": [
            {
                "uuid": null,
                "type": "group",
                "displayName": null
            }
        ]
    },
    "status": 200
}

User Info

The service to work with user info

User info

POST

/api/integr/v1.0/info/userInfo

This endpoint returns information about a single Consensus User based on

the user_email value sent in via the auth request.

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

Response Fields

data

object

user

object

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

status

string

Example:

active

boolean

Example:

true

string

Example:

example@email.domain

firstName

string

Example:

John

lastName

string

Example:

Smith

displayName

string

Example:

John Smith

groupType

string

Example:

Organization

timeCreated

string

Example:

1970-01-01T12:10:15+0000

timeUpdated

string

Example:

1970-01-01T12:10:15+0000

avatar

string

Example:

contentUuid: zzzzzzzz-zzzzz-zzzzz-zzzz-zzzzzzzzzzzz

phoneNumber

string

Example:

Test phone

twitterLink

string

Example:

twitterLink

linkedinLink

string

Example:

linkedinLink

googleLink

string

Example:

googleLink

group

object

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

status

string

Example:

active

name

string

Example:

Organization name

type

string

Example:

organization

level

integer

Example:

timeCreated

string

Example:

1970-01-01T12:10:15+0000

timeUpdated

string

Example:

1970-01-01T12:10:15+0000

parentUuid

string

Example:

yyyyyyyy-yyyyy-yyyyy-yyyy-yyyyyyyyyyyy

description

string

Example:

Group description

creatorUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

creatorFullName

string

Example:

Creator name

status

integer

Example:

200

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": true } }

Received response

Example response :

{
    "data": {
        "user": {
            "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "status": null,
            "active": true,
            "email": "example@email.domain",
            "firstName": "John",
            "lastName": "Smith",
            "displayName": "John Smith",
            "groupType": "Organization",
            "timeCreated": "1970-01-01T12:10:15+0000",
            "timeUpdated": "1970-01-01T12:10:15+0000",
            "avatar": "contentUuid: zzzzzzzz-zzzzz-zzzzz-zzzz-zzzzzzzzzzzz",
            "phoneNumber": "Test phone",
            "twitterLink": "twitterLink",
            "linkedinLink": "linkedinLink",
            "googleLink": "googleLink"
        },
        "group": {
            "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "status": "active",
            "name": "Organization name",
            "type": "organization",
            "level": 0,
            "timeCreated": "1970-01-01T12:10:15+0000",
            "timeUpdated": "1970-01-01T12:10:15+0000",
            "parentUuid": "yyyyyyyy-yyyyy-yyyyy-yyyy-yyyyyyyyyyyy",
            "description": "Group description",
            "creatorUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "creatorFullName": "Creator name"
        }
    },
    "status": 200
}

Marketing

The marketing collection is all about Consensus public links, and working with leads generated

from Consensus. You can create new public links, create a new lead, or fetch all leads using the search endpoint.

Searchleads

POST

/api/integr/v1.0/marketing/searchleads

Returns Lead contacts information.

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

paging

object

limit

integer

Min value 1, max value 500

Example:

100

page

integer

Example:

sortBy

string

Example:

order

string

Example:

asc

Enum:

[asc, desc]

start_date

string

Example:

2018-01-01

end_date

string

Example:

2018-12-31

demoUuid

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

contactUuid

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

string[]

Example:

["example@email.domain"]

Response Fields

data

object

items

object[]

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

demoUuid

string

Demo uuid from what lead has come

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

viewId

string

view id (should be used for heatmap)

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

heatmapUrl

string

Example:

http://example.domain/path?parameters

string

Example:

example@email.domain

firstName

string

Example:

John

lastName

string

Example:

Smith

organization

string

Example:

company name

leadOwnerGroup

string

Example:

Lead Owner Group Name

docDownloads

string

Example:

viewTime

string

Example:

creationDate

string

Example:

2018-08-22T08:22:55+0000

utm

object

Example:

form

object

Example:

dateView

string

Example:

1546367750

demoTitle

string

Example:

Demo title

answerIndex

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

answerName

string

Example:

Answer name

features

object[]

geoData

object

postalCode

string

Example:

10001

latitude

string

Example:

40.711413

longitude

string

Example:

-74.015369

localeCode

string

Example:

continentCode

string

Example:

continentName

string

Example:

North America

countryIsoCode

string

Example:

countryName

string

Example:

United States

timeZone

string

Example:

America/Los_Angeles

answer

object

parentDemoTitle

string

Example:

sample demo

parentDemoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

selectedDemoTitle

string

Example:

Sample embedded demo

selectedDemoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

selectedIndex

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

selectedText

string

Example:

Sample answer to question

paging

object[]

countItems

integer

Example:

limit

integer

Example:

page

integer

Example:

integer

Example:

integer

Example:

sorting

string[]

Example:

status

integer

Example:

200

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": true }, "paging": { "limit": 100, "page": 1, "order": "asc" }, "start_date": "2018-01-01", "end_date": "2018-12-31", "demoUuid": [ "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" ], "contactUuid": [ "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" ], "email": [ "example@email.domain" ] }

Received response

Example response :

{
    "data": {
        "items": [
            {
                "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "demoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "viewId": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "heatmapUrl": "http://example.domain/path?parameters",
                "email": "example@email.domain",
                "firstName": "John",
                "lastName": "Smith",
                "organization": "company name",
                "leadOwnerGroup": "Lead Owner Group Name",
                "docDownloads": "12",
                "viewTime": "12",
                "creationDate": "2018-08-22T08:22:55+0000",
                "utm": null,
                "form": null,
                "dateView": 1546367750,
                "demoTitle": "Demo title",
                "answerIndex": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "answerName": "Answer name",
                "features": [
                    {
                        "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "title": "feature title",
                        "value": "high|medium|none"
                    }
                ],
                "geoData": {
                    "postalCode": "10001",
                    "latitude": "40.711413",
                    "longitude": "-74.015369",
                    "localeCode": "en",
                    "continentCode": "NA",
                    "continentName": "North America",
                    "countryIsoCode": "US",
                    "countryName": "United States",
                    "timeZone": "America/Los_Angeles"
                },
                "answer": {
                    "parentDemoTitle": "sample demo",
                    "parentDemoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "selectedDemoTitle": "Sample embedded demo",
                    "selectedDemoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "selectedIndex": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "selectedText": "Sample answer to question"
                }
            }
        ],
        "paging": [
            {
                "countItems": 0,
                "limit": 0,
                "page": 0,
                "nextPage": 0,
                "previousPage": 0
            }
        ],
        "sorting": null
    },
    "status": 200
}

Createlead

POST

/api/integr/v1.0/marketing/createlead

Create a new lead.

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

utm

object

utm_campaign

string

Example:

demo

utm_content

string

Example:

text

utm_medium

string

Example:

utm_source

string

Example:

Google_Adword

utm_term

string

Example:

key_word

fields

object

string

Example:

your@email.here

firstName

string

Example:

John

lastName

string

Example:

Smith

phoneNumber

string

Example:

You can use any formats

organization

string

Example:

Test company

title

string

Example:

Test title

comments

string

Example:

Leave Your comments here

Response Fields

data

object

status

integer

Example:

200

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": true }, "utm": { "utm_campaign": "demo", "utm_content": "text", "utm_medium": "email", "utm_source": "Google_Adword", "utm_term": "key_word" }, "fields": { "email": "your@email.here", "firstName": "John", "lastName": "Smith", "phoneNumber": "You can use any formats", "organization": "Test company", "title": "Test title", "comments": "Leave Your comments here" } }

Received response

Example response :

{
    "data": {
        "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"
    },
    "status": 200
}

Createlink

POST

/api/integr/v1.0/marketing/createlink

 * Creates a new marketing link and provides the UUID and Hash for that link.
 *

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

demo_uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

creationSource

string

Example:

sfdc,outlook,outreach,ios,android,snap,gsnap,zapier,api,webapp

Response Fields

data

object

status

integer

Example:

200

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": true }, "demo_uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "creationSource": "sfdc,outlook,outreach,ios,android,snap,gsnap,zapier,api,webapp" }

Received response

Example response :

{
    "data": {
        "item": {
            "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "hash": "ddfsdfsd"
        }
    },
    "status": 200
}

Sales

The Sales collection lets you retrieve or search for sales demolytics data by demoboard,

recipient, or other unique identifiers. You can also create and update DemoBoard links.

Search

POST

/api/integr/v1.0/sales/search

Returns Track Demos Sent data by date range and demo uuids.

The timeframe within start_date and end_date in request determines the timeframe of the last DemoBoard
update. Response returns DemoBoard(s) with the last DemoBoard updated date within the provided timeframe in the
request

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

paging

object

limit

integer

Min value 1, max value 500

Example:

100

page

integer

Example:

sortBy

string

Example:

order

string

Example:

asc

Enum:

[asc, desc]

externalOpportunityFilter

object

start_date

string

Example:

2018-01-01

end_date

string

Example:

2018-12-31

demoUuid

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

senddemoUuid

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

senddemoHash

string[]

Example:

["xxxxxxxx"]

inviteUuid

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

inviteHash

string[]

Example:

["xxxxxxxx"]

string[]

Example:

["example@email.domain"]

Response Fields

data

object

items

object[]

senddemoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

senddemoHash

string

Example:

bc85667a

demoboardName

string

Example:

Test title

isTest

boolean

Example:

false

demoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

parentDemoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

demoUuids

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

parentDemoUuids

string[]

Example:

["xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"]

organization

string

Example:

Test organization

opportunity

string

Example:

Internal opportunity

viewCount

string

Example:

viewTime

string

Example:

346.0

ownerUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

ownerName

string

Example:

John Doe

totalHotspotOpened

integer

Example:

totalPageViews

integer

Example:

totalTourViews

integer

Example:

externalOpportunity

object

sharedCount

integer

Example:

invites

object[]

name

string

Example:

John Smith

contactUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

title

string

Example:

Test title

totalDuration

number

Example:

21.2468

integer

Example:

primary

string

Example:

primary

hash

string

Example:

c46eea41

inviteUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

string

Example:

example@email.domain

views

number

Example:

source

string

Example:

sourceHR

string

Example:

Link that was shared

ownerUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

ownerName

string

Example:

John Doe

sharedByUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

sharedByName

string

Example:

John Doe

totalHotspotsOpened

integer

Example:

totalPageViews

integer

Example:

totalTourViews

integer

Example:

viewData

object[]

dateView

string

Example:

YYYY-MM-DD HH:MM:SS

linkUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

viewId

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

selectedDemoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

demoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

demoTitle

string

Example:

Test title

isReplay

integer

Example:

duration

number

Example:

7.8311

files

integer

Example:

answerIndex

string

Example:

xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

answerName

string

Example:

Answer name

features

object[]

creationDate

string

Example:

1550650730

timeLastView

string

Example:

1550650730

creationSource

string

Example:

sfdc,outlook,outreach,ios,android,snap,gsnap,zapier,api,webapp

paging

object[]

countItems

integer

Example:

limit

integer

Example:

page

integer

Example:

integer

Example:

integer

Example:

sorting

string[]

Example:

status

integer

Example:

200

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": true }, "paging": { "limit": 100, "page": 1, "order": "asc" }, "externalOpportunityFilter": { "externalOpportunityAssignment": "ALL" }, "start_date": "2018-01-01", "end_date": "2018-12-31", "demoUuid": [ "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" ], "senddemoUuid": [ "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" ], "senddemoHash": [ "xxxxxxxx" ], "inviteUuid": [ "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" ], "inviteHash": [ "xxxxxxxx" ], "email": [ "example@email.domain" ] }

Received response

Example response :

{
    "data": {
        "items": [
            {
                "senddemoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "senddemoHash": "bc85667a",
                "demoboardName": "Test title",
                "isTest": true,
                "demoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "parentDemoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "demoUuids": [
                    "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"
                ],
                "parentDemoUuids": [
                    "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"
                ],
                "organization": "Test organization",
                "opportunity": "Internal opportunity",
                "viewCount": "12",
                "viewTime": "346.0",
                "ownerUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "ownerName": "John Doe",
                "totalHotspotOpened": 0,
                "totalPageViews": 0,
                "totalTourViews": 0,
                "externalOpportunity": {
                    "externalOpportunityId": "1232321321",
                    "externalOpportunityName": "Opportunity name",
                    "externalAccountId": "1232321321",
                    "externalAccountName": "Account name"
                },
                "sharedCount": 10,
                "invites": [
                    {
                        "name": "John Smith",
                        "contactUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "title": "Test title",
                        "totalDuration": 21.2468,
                        "shares": 4,
                        "primary": "primary",
                        "hash": "c46eea41",
                        "inviteUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "email": "example@email.domain",
                        "views": 3,
                        "source": "invite_others|legacy|share|snap|way|integration",
                        "sourceHR": "Link that was shared",
                        "ownerUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "ownerName": "John Doe",
                        "sharedByUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                        "sharedByName": "John Doe",
                        "totalHotspotsOpened": 0,
                        "totalPageViews": 0,
                        "totalTourViews": 0,
                        "viewData": [
                            {
                                "dateView": "YYYY-MM-DD HH:MM:SS",
                                "linkUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                                "viewId": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                                "selectedDemoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                                "demoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                                "demoTitle": "Test title",
                                "isReplay": 1,
                                "duration": 7.8311,
                                "files": 3,
                                "answerIndex": "xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                                "answerName": "Answer name",
                                "features": [
                                    {
                                        "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                                        "title": "feature title"
                                    }
                                ]
                            }
                        ]
                    }
                ],
                "creationDate": 1550650730,
                "timeLastView": 1550650730,
                "creationSource": "sfdc,outlook,outreach,ios,android,snap,gsnap,zapier,api,webapp"
            }
        ],
        "paging": [
            {
                "countItems": 0,
                "limit": 0,
                "page": 0,
                "previousPage": 0,
                "nextPage": 0
            }
        ],
        "sorting": null
    },
    "status": 200
}

Createsenddemo

POST

/api/integr/v1.0/sales/createsenddemo

Create a DemoBoard with recipients and receive a unique DemoBoard hash ID.

This hash can be appended to the end of play.goconsensus.com/{hash} to create a live DemoBoard URL.

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

demo_uuid

string

required

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

organization

string

required

Example:

Test organization

opportunity

string

Example:

isTest

boolean

Example:

true

title

string

Link title, used for mailmerge links only

Example:

externalOpportunity

object

creationSource

string

Example:

sfdc,outlook,outreach,ios,android,snap,gsnap,zapier,api,webapp,highspot,lucid,seismic,showpad,miro,gong,dynamics,clari

share_to

object[]

contact_email

string

required

Example:

example@email.domain

first_name

string

Example:

John

last_name

string

Example:

Smith

title

string

Example:

Test title

external_contact_id

string

Example:

123-123

Response Fields

data

object

item

object

senddemo_uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

senddemo_hash

string

Example:

ddfsdfsd

isTest

boolean

Example:

false

recipients

object[]

invite_hash

string

Example:

ddfsdfsd

invite_uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

contact_uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

string

Example:

example@email.domain

first_name

string

Example:

John

last_name

string

Example:

Smith

status

integer

Example:

200

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": true }, "demo_uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "organization": "Test organization", "isTest": true, "externalOpportunity": { "externalAccountId": "123-123", "externalAccountName": "Account Name", "externalOpportunityId": "123-123", "externalOpportunityName": "Opportunity Name" }, "creationSource": "sfdc,outlook,outreach,ios,android,snap,gsnap,zapier,api,webapp,highspot,lucid,seismic,showpad,miro,gong,dynamics,clari", "share_to": [ { "contact_email": "example@email.domain", "first_name": "John", "last_name": "Smith", "title": "Test title", "external_contact_id": "123-123" } ] }

Received response

Example response :

{
    "data": {
        "item": {
            "senddemo_uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "senddemo_hash": "ddfsdfsd",
            "isTest": true,
            "recipients": [
                {
                    "invite_hash": "ddfsdfsd",
                    "invite_uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "contact_uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "email": "example@email.domain",
                    "first_name": "John",
                    "last_name": "Smith"
                }
            ]
        }
    },
    "status": 200
}

Updatesenddemo

POST

/api/integr/v1.0/sales/updatesenddemo

Update an existing DemoBoard and it’s metadata using the unique DemoBoard UUID.

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

uuid

string

required

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

organization

string

Example:

Test organization

opportunity

string

Example:

isTest

boolean

Example:

true

contactInfoUuid

string

Example:

showUserContactInfo

boolean

Example:

true

noViewNotifications

object

externalOpportunity

object

Response Fields

auth

object

api_key

string

Example:

XXXXX...XXX

api_secret

string

Example:

XXXXX...XXX

user_email

string

Example:

example@email.domain

source_name

string

Example:

service name

user_activity

boolean

Example:

true

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

organization

string

Example:

Test organization

opportunity

string

Example:

isTest

boolean

Example:

true

contactInfoUuid

string

Example:

showUserContactInfo

boolean

Example:

true

noViewNotifications

object

externalOpportunity

object

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": true }, "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "organization": "Test organization", "isTest": true, "showUserContactInfo": true, "noViewNotifications": { "isEnabled": true, "repeatPeriod": 3, "repeatTimes": 5 }, "externalOpportunity": { "externalAccountId": "123-123", "externalAccountName": "Account Name", "externalOpportunityId": "123-123", "externalOpportunityName": "Opportunity Name" } }

Received response

Example response :

{
    "auth": {
        "api_key": "XXXXX...XXX",
        "api_secret": "XXXXX...XXX",
        "user_email": "example@email.domain",
        "source_name": "service name",
        "user_activity": true
    },
    "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
    "organization": "Test organization",
    "opportunity": null,
    "isTest": true,
    "contactInfoUuid": null,
    "showUserContactInfo": true,
    "noViewNotifications": {
        "isEnabled": true,
        "repeatPeriod": 3,
        "repeatTimes": 5
    },
    "externalOpportunity": {
        "externalAccountId": "123-123",
        "externalAccountName": "Account Name",
        "externalOpportunityId": "123-123",
        "externalOpportunityName": "Opportunity Name"
    }
}

Setting

The service to work with Setting

Create web hook

POST

/api/integr/v1.0/setting/createWebHook

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

url

string

Example:

http://example.domain/

format

string

Example:

json

Enum:

[json, xml]

status

string

Example:

active

Enum:

[active, inactive]

events

string[]

Example:

["new_lead"]

Enum:

[new_lead, demo_utm, demo_watch]

Response Fields

data

object

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

url

string

Example:

http://example.domain/

format

string

Example:

json

status

string

Example:

active

events

string[]

Example:

["new_lead"]

Enum:

[new_lead, demo_utm, demo_watch]

status

integer

Example:

200

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": true }, "url": "http:\/\/example.domain\/", "format": "json", "status": "active", "events": [ "new_lead" ] }

Received response

Example response :

{
    "data": {
        "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
        "url": "http://example.domain/",
        "format": "json",
        "status": "active",
        "events": "new_lead"
    },
    "status": 200
}

Delete web hook

POST

/api/integr/v1.0/setting/deleteWebHook

delete webhook by uuid

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

uuid

string

required

Example:

Response Fields

message

string

Example:

Successfully message

status

integer

Example:

200

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": true }, "uuid": null }

Received response

Example response :

{
    "message": "Successfully message",
    "status": 200
}

Web hook list

POST

/api/integr/v1.0/setting/webHookList

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

paging

object

limit

integer

Min value 1, max value 500

Example:

100

page

integer

Example:

sortBy

string

Example:

order

string

Example:

asc

Enum:

[asc, desc]

Response Fields

data

object

items

object[]

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

url

string

Example:

http://example.domain/

format

string

Example:

json

status

string

Example:

active

events

string[]

Example:

["new_lead"]

Enum:

[new_lead, demo_utm, demo_watch]

paging

object[]

countItems

integer

Example:

limit

integer

Example:

page

integer

Example:

integer

Example:

integer

Example:

sorting

string[]

Example:

status

integer

Example:

200

Headers

Body

Received response

Example response :

{
    "data": {
        "items": [
            {
                "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "url": "http://example.domain/",
                "format": "json",
                "status": "active",
                "events": "new_lead"
            }
        ],
        "paging": [
            {
                "countItems": 0,
                "limit": 0,
                "page": 0,
                "nextPage": 0,
                "previousPage": 0
            }
        ],
        "sorting": null
    },
    "status": 200
}

Recipient

Use this method to Get or Delete Leads based on recipient email.

The Delete action is for anonymizing the data associated with a lead,
not deleting it entirely from our platform.

Get

POST

/api/integr/v1.0/user/get

Returns the leads based on the given email

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

paging

object

limit

integer

Min value 1, max value 500

Example:

100

page

integer

Example:

sortBy

string

Example:

order

string

Example:

asc

Enum:

[asc, desc]

string

Example:

example@email.domain

Response Fields

data

object

items

object[]

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

string

Example:

example@email.domain

firstName

string

Example:

John

lastName

string

Example:

Smith

phoneNumber

string

Example:

Test phone

timeCreated

string

Example:

1970-01-01T12:10:15+0000

paging

object[]

countItems

integer

Example:

limit

integer

Example:

page

integer

Example:

integer

Example:

integer

Example:

status

integer

Example:

200

Headers

Body

Received response

Example response :

{
    "data": {
        "items": [
            {
                "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "email": "example@email.domain",
                "firstName": "John",
                "lastName": "Smith",
                "phoneNumber": "Test phone",
                "timeCreated": "1970-01-01T12:10:15+0000"
            }
        ],
        "paging": [
            {
                "countItems": 0,
                "limit": 0,
                "page": 0,
                "nextPage": 0,
                "previousPage": 0
            }
        ]
    },
    "status": 200
}

Delete

POST

/api/integr/v1.0/user/delete

Anonymizes leads based on their email for the current organization

Anonymization means replacing actual leads info with a set of random chars.
So that, after anonymization, the leads info will look like this:
Email: lhsegwfvruvaqj@dzarotk.com
Firstname: 9WTjQ1Rf
Lastname: pxNDOiVsZIWg
Title: dGisUeB0Hxr1vguZL
Note: Leads anonymization is an asynchronous background operation.
So it may take some time and leads will not be anonymized immediately after the request.

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

true

string

Example:

example@email.domain

Response Fields

message

string

Example:

Successfully message

status

integer

Example:

200

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": true }, "email": "example@email.domain" }

Received response

Example response :

{
    "message": "Successfully message",
    "status": 200
}

Mail Merge

The Mail Merge collection, lets you create, list and update mail merge links programmatically.

Create

POST

/api/integration-links/v1.0/mail-merge/create

Create new mail merge links, and have control over granular settings such as chosen format, associated contact information, way page skip, combine recipients, expiration by days and more!

Note: in order to create a new link, you’ll need the platform (format) uuid. You can get this from querying the “platforms” endpoints within this collection.

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

false

demoUuid

string

required

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

title

string

required

Example:

string

platformId

integer

required

This field is optional in case 'placeholders' attribute exist in the request payload

Example:

combine

boolean

Example:

true

skipWay

boolean

Example:

true

contactInfoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

showUserContactInfo

boolean

Example:

true

rivSource

string

Example:

none

Enum:

[none, default, custom]

excludeOwner

boolean

Example:

true

defaultRivUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

customRivUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

expirationByDays

boolean

Example:

true

enableTwoFactorAuthentication

boolean

Example:

true

expirationByDaysCount

integer

This field is required in case attribute 'expirationByDays' in request is 'true'. The value should be in range 1-999

Example:

placeholders

object

required

This field is optional in case 'platformId' attribute exist in the request payload

string

Example:

string

firstName

string

Example:

string

lastName

string

Example:

string

company

string

Example:

string

title

string

Example:

string

senderEmail

string

Example:

string

access

object

permissions

object[]

Response Fields

data

object

item

object

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

hash

string

Example:

xxxxxxxx

title

string

Example:

Mail Merge Link

createdAt

string

Example:

2023-08-22T08:22:55+0000

showUserContactInfo

boolean

Example:

true

contactInfoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

rivSource

string

Example:

none

rivUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

combine

boolean

Example:

true

skipWay

boolean

Example:

true

excludeOwner

boolean

Example:

true

demo

object

owner

object

platform

object

permissions

object[]

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": false }, "demoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "title": "string", "platformId": 10, "combine": true, "skipWay": true, "contactInfoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "showUserContactInfo": true, "rivSource": "none", "excludeOwner": true, "defaultRivUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "customRivUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "expirationByDays": true, "enableTwoFactorAuthentication": true, "expirationByDaysCount": 10, "placeholders": { "email": "string", "firstName": "string", "lastName": "string", "company": "string", "title": "string", "senderEmail": "string" }, "access": { "level": 1, "flag": "string", "values": [ "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" ] }, "permissions": [ { "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "type": "user", "sharedBelow": true } ] }

Received response

Example response :

{
    "data": {
        "item": {
            "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "hash": "xxxxxxxx",
            "title": "Mail Merge Link",
            "createdAt": "2023-08-22T08:22:55+0000",
            "showUserContactInfo": true,
            "contactInfoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "rivSource": "none",
            "rivUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "combine": true,
            "skipWay": true,
            "excludeOwner": true,
            "demo": {
                "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "title": "Demo title",
                "internalTitle": "Demo title"
            },
            "owner": {
                "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "name": "John Doe",
                "phone": "Test phone"
            },
            "platform": {
                "id": 10,
                "name": "Platform name"
            },
            "permissions": [
                {
                    "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "type": "user",
                    "sharedBelow": true
                }
            ]
        }
    }
}

Get

POST

/api/integration-links/v1.0/mail-merge/get

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

false

uuid

string

required

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

Response Fields

data

object

item

object

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

hash

string

Example:

xxxxxxxx

title

string

Example:

Mail Merge Link

createdAt

string

Example:

2023-08-22T08:22:55+0000

showUserContactInfo

boolean

Example:

true

contactInfoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

rivSource

string

Example:

none

rivUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

combine

boolean

Example:

true

skipWay

boolean

Example:

true

excludeOwner

boolean

Example:

true

demo

object

owner

object

platform

object

permissions

object[]

placeholders

object

string

Example:

string

firstName

string

Example:

string

lastName

string

Example:

string

company

string

Example:

string

title

string

Example:

string

senderEmail

string

Example:

string

notifications

object

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": false }, "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" }

Received response

Example response :

{
    "data": {
        "item": {
            "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "hash": "xxxxxxxx",
            "title": "Mail Merge Link",
            "createdAt": "2023-08-22T08:22:55+0000",
            "showUserContactInfo": true,
            "contactInfoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "rivSource": "none",
            "rivUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "combine": true,
            "skipWay": true,
            "excludeOwner": true,
            "demo": {
                "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "title": "Demo title",
                "internalTitle": "Demo title"
            },
            "owner": {
                "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "name": "John Doe",
                "phone": "Test phone"
            },
            "platform": {
                "id": 10,
                "name": "Platform name"
            },
            "permissions": [
                {
                    "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "type": "user",
                    "sharedBelow": true
                }
            ],
            "placeholders": {
                "email": "string",
                "firstName": "string",
                "lastName": "string",
                "company": "string",
                "title": "string",
                "senderEmail": "string"
            },
            "notifications": {
                "level": 1,
                "flag": "string",
                "values": [
                    "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx"
                ]
            }
        }
    }
}

List

POST

/api/integration-links/v1.0/mail-merge/list

Retrieve or search mail merge links by title.

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

false

query

string

Example:

absent

paging

object

limit

integer

Allowed range 0-100. In case limit sent as 0, then default 20 will be used.

Example:

100

page

integer

Example:

sortBy

string

Example:

timeCreated

Enum:

[timeCreated, uuid, title, platform]

order

string

Example:

asc

Enum:

[asc, desc]

Response Fields

data

object

items

object[]

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

hash

string

Example:

xxxxxxxx

title

string

Example:

Mail Merge Link

createdAt

string

Example:

2023-08-22T08:22:55+0000

showUserContactInfo

boolean

Example:

true

contactInfoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

rivSource

string

Example:

none

rivUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

combine

boolean

Example:

true

skipWay

boolean

Example:

true

excludeOwner

boolean

Example:

true

demo

object

owner

object

platform

object

paging

object

countItems

integer

Example:

limit

integer

Example:

500

page

integer

Example:

integer

Example:

null

integer

Example:

null

sorting

string[]

Example:

["title"]

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": false }, "query": "absent", "paging": { "limit": 100, "page": 1, "sortBy": "timeCreated", "order": "asc" } }

Received response

Example response :

{
    "data": {
        "items": [
            {
                "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "hash": "xxxxxxxx",
                "title": "Mail Merge Link",
                "createdAt": "2023-08-22T08:22:55+0000",
                "showUserContactInfo": true,
                "contactInfoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "rivSource": "none",
                "rivUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "combine": true,
                "skipWay": true,
                "excludeOwner": true,
                "demo": {
                    "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "title": "Demo title",
                    "internalTitle": "Demo title"
                },
                "owner": {
                    "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "name": "John Doe",
                    "phone": "Test phone"
                },
                "platform": {
                    "id": 10,
                    "name": "Platform name"
                }
            }
        ],
        "paging": {
            "countItems": 1,
            "limit": 500,
            "page": 1,
            "nextPage": null,
            "previousPage": null
        },
        "sorting": [
            "title"
        ]
    }
}

Update

PUT

/api/integration-links/v1.0/mail-merge/update

Update mail merge links, and their associated settings.

Body Parameters

uuid

string

required

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

false

demoUuid

string

required

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

title

string

required

Example:

string

platformId

integer

required

This field is optional in case 'placeholders' attribute exist in the request payload

Example:

combine

boolean

Example:

true

skipWay

boolean

Example:

true

contactInfoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

showUserContactInfo

boolean

Example:

true

rivSource

string

Example:

none

Enum:

[none, default, custom]

excludeOwner

boolean

Example:

true

defaultRivUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

customRivUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

expirationByDays

boolean

Example:

true

enableTwoFactorAuthentication

boolean

Example:

true

expirationByDaysCount

integer

This field is required in case attribute 'expirationByDays' in request is 'true'. The value should be in range 1-999

Example:

placeholders

object

required

This field is optional in case 'platformId' attribute exist in the request payload

string

Example:

string

firstName

string

Example:

string

lastName

string

Example:

string

company

string

Example:

string

title

string

Example:

string

senderEmail

string

Example:

string

access

object

permissions

object[]

Response Fields

data

object

item

object

uuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

hash

string

Example:

xxxxxxxx

title

string

Example:

Mail Merge Link

createdAt

string

Example:

2023-08-22T08:22:55+0000

showUserContactInfo

boolean

Example:

true

contactInfoUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

rivSource

string

Example:

none

rivUuid

string

Example:

xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx

combine

boolean

Example:

true

skipWay

boolean

Example:

true

excludeOwner

boolean

Example:

true

demo

object

owner

object

platform

object

permissions

object[]

Headers

Body

{ "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": false }, "demoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "title": "string", "platformId": 10, "combine": true, "skipWay": true, "contactInfoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "showUserContactInfo": true, "rivSource": "none", "excludeOwner": true, "defaultRivUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "customRivUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "expirationByDays": true, "enableTwoFactorAuthentication": true, "expirationByDaysCount": 10, "placeholders": { "email": "string", "firstName": "string", "lastName": "string", "company": "string", "title": "string", "senderEmail": "string" }, "access": { "level": 1, "flag": "string", "values": [ "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx" ] }, "permissions": [ { "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx", "type": "user", "sharedBelow": true } ] }

Received response

Example response :

{
    "data": {
        "item": {
            "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "hash": "xxxxxxxx",
            "title": "Mail Merge Link",
            "createdAt": "2023-08-22T08:22:55+0000",
            "showUserContactInfo": true,
            "contactInfoUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "rivSource": "none",
            "rivUuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
            "combine": true,
            "skipWay": true,
            "excludeOwner": true,
            "demo": {
                "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "title": "Demo title",
                "internalTitle": "Demo title"
            },
            "owner": {
                "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                "name": "John Doe",
                "phone": "Test phone"
            },
            "platform": {
                "id": 10,
                "name": "Platform name"
            },
            "permissions": [
                {
                    "uuid": "xxxxxxxx-xxxxx-xxxxx-xxxx-xxxxxxxxxxxx",
                    "type": "user",
                    "sharedBelow": true
                }
            ]
        }
    }
}

Platforms

POST

/api/integration-links/v1.0/mail-merge/platforms

Retrieve list of all platform formats and their associated UUIDs that we currently have available for MML link creation inside of Consensus. You’ll need one of these ideas to create a new MML link via the api.

Body Parameters

auth

object

required

api_key

string

required

Example:

XXXXX...XXX

api_secret

string

required

Example:

XXXXX...XXX

user_email

string

required

Example:

example@email.domain

source_name

string

required

Example:

service name

user_activity

boolean

Example:

false

Response Fields

data

object

items

object[]

integer

Example:

name

string

Example:

MMPlatform

placeholders

object

string

Example:

string

firstName

string

Example:

string

lastName

string

Example:

string

company

string

Example:

string

title

string

Example:

string

senderEmail

string

Example:

string

Headers

Body

{ "auth": { "api_key": "XXXXX...XXX", "api_secret": "XXXXX...XXX", "user_email": "example@email.domain", "source_name": "service name", "user_activity": false } }

Received response

Example response :

{
    "data": {
        "items": [
            {
                "id": 10,
                "name": "MMPlatform",
                "placeholders": {
                    "email": "string",
                    "firstName": "string",
                    "lastName": "string",
                    "company": "string",
                    "title": "string",
                    "senderEmail": "string"
                }
            }
        ]
    }
}