Skip to main content
Versionv1

API (v1.0)

Download OpenAPI specification:Download

Events

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/{profileId}/events

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
profileId
required
string
query Parameters
take
integer <int32>
cursor
string
search
string

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/{profileId}/events/_summary

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
profileId
required
string

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/{profileId}/events/_overview

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
profileId
required
string
query Parameters
take
required
integer <int32>
Default: 25

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/events

path Parameters
tenantId
required
string <uuid>
query Parameters
skip
integer <int32>
take
integer <int32>
Default: 2147483647
Request Body schema:
eventTypeIds
Array of strings or null <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "eventTypeIds": [
    ]
}

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/events/_count

path Parameters
tenantId
required
string <uuid>
Request Body schema:
eventTypeIds
Array of strings or null <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "eventTypeIds": [
    ]
}

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/events/{eventId}

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
eventId
required
string <uuid>

Responses

Response samples

Content type
No sample

EventTypes

/profile/v1.0/tenants/{tenantId}/eventtypes

path Parameters
tenantId
required
string <uuid>
query Parameters
skip
integer <int32>
take
integer <int32>
Default: 2147483647
isMapped
boolean
Default: false
isUnmapped
boolean
Default: false
dependencyKey
string <uuid>

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/eventtypes

path Parameters
tenantId
required
string <uuid>
Request Body schema:
id
string <uuid>
name
string or null
Array of objects or null (CM.Data.Core.Profiles.Api.Models.ApiEventTypeProperty)

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "properties": [
    ]
}

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/eventtypes

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/eventtypes/{eventTypeId}

path Parameters
tenantId
required
string <uuid>
eventTypeId
required
string <uuid>

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/eventtypes/{eventTypeId}

path Parameters
tenantId
required
string <uuid>
eventTypeId
required
string <uuid>
query Parameters
ignoreDependencyLinkValidation
boolean
Default: false
Request Body schema:
id
string <uuid>
name
string or null
Array of objects or null (CM.Data.Core.Profiles.Api.Models.ApiEventTypeProperty)

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "properties": [
    ]
}

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/eventtypes/{eventTypeId}

path Parameters
tenantId
required
string <uuid>
eventTypeId
required
string <uuid>
Request Body schema:
id
string <uuid>
name
string or null
Array of objects or null (CM.Data.Core.Profiles.Api.Models.ApiEventTypeProperty)

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "properties": [
    ]
}

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/eventtypes/{eventTypeId}

path Parameters
tenantId
required
string <uuid>
eventTypeId
required
string <uuid>

Responses

Exports

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/csv

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/{profileId}/export

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
profileId
required
string

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/exportevents

path Parameters
tenantId
required
string <uuid>
query Parameters
queryString
string
unordered
boolean
Default: false
excludeProfile
boolean
Default: false

Responses

Response samples

Content type
No sample

Profiles

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
query Parameters
skip
integer <int32>
take
integer <int32>
Default: 2147483647
sortOn
string
reverse
boolean
Default: false

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/_query

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
query Parameters
skip
integer <int32>
take
integer <int32>
Default: 2147483647
sortOn
string
reverse
boolean
Default: false
Request Body schema:
object (CM.Data.QueryLanguage.Nodes.Node)
object (CM.Data.QueryLanguage.Nodes.Node)

Responses

Request samples

Content type
{
  • "root": { }
}

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/_count

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/_count

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
Request Body schema:
object (CM.Data.QueryLanguage.Nodes.Node)
object (CM.Data.QueryLanguage.Nodes.Node)

Responses

Request samples

Content type
{
  • "root": { }
}

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/segments/{segmentId}/count

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
segmentId
required
string <uuid>

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/segments/{segmentId}/profiles

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
segmentId
required
string <uuid>
query Parameters
skip
integer <int32>
take
integer <int32>
Default: 2147483647
sortOn
string
reverse
boolean
Default: false

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/bytoken/{profileToken}

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
profileToken
required
string

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/bytoken/{profileToken}/details

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
profileToken
required
string

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/bytoken/{profileToken}/_hard

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
profileToken
required
string

Responses

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/profiles/byquery/_hard

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
Request Body schema:
object (CM.Data.QueryLanguage.Nodes.Node)
object (CM.Data.QueryLanguage.Nodes.Node)

Responses

Request samples

Content type
{
  • "root": { }
}

ProfileTypeProperties

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/properties

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
query Parameters
skip
integer <int32>
take
integer <int32>
Default: 2147483647

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/properties

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
Request Body schema:
id
string <uuid>
name
string or null
type
integer <int32> (CM.Data.Domain.Enums.PropertyType)
Enum: 0 1 2 100 101 102 103 104
possibleOriginTypes
Array of integers or null <int32> (CM.Data.Domain.Enums.PropertyType) [ items <int32 > ]
Enum: 0 1 2 100 101 102 103 104
isKey
boolean
externalKey
integer <int32> (CM.Data.Core.Profiles.Shared.Enums.ExternalKey)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
isNotIndexed
boolean
maxOccurences
integer or null <int32>
object (CM.Data.Core.Profiles.Api.Models.ApiPropertyDisplayModel)
operatorName
string or null
sourceEventTypeIds
Array of strings or null <uuid> [ items <uuid > ]
sourceProfileTypeIds
Array of strings or null <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": 0,
  • "possibleOriginTypes": [
    ],
  • "isKey": true,
  • "externalKey": 0,
  • "isNotIndexed": true,
  • "maxOccurences": 0,
  • "displayModel": {
    },
  • "operatorName": "string",
  • "sourceEventTypeIds": [
    ],
  • "sourceProfileTypeIds": [
    ]
}

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/properties/{propertyId}

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
propertyId
required
string <uuid>

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/properties/{propertyId}

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
propertyId
required
string <uuid>
Request Body schema:
id
string <uuid>
name
string or null
type
integer <int32> (CM.Data.Domain.Enums.PropertyType)
Enum: 0 1 2 100 101 102 103 104
possibleOriginTypes
Array of integers or null <int32> (CM.Data.Domain.Enums.PropertyType) [ items <int32 > ]
Enum: 0 1 2 100 101 102 103 104
isKey
boolean
externalKey
integer <int32> (CM.Data.Core.Profiles.Shared.Enums.ExternalKey)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
isNotIndexed
boolean
maxOccurences
integer or null <int32>
object (CM.Data.Core.Profiles.Api.Models.ApiPropertyDisplayModel)
operatorName
string or null
sourceEventTypeIds
Array of strings or null <uuid> [ items <uuid > ]
sourceProfileTypeIds
Array of strings or null <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": 0,
  • "possibleOriginTypes": [
    ],
  • "isKey": true,
  • "externalKey": 0,
  • "isNotIndexed": true,
  • "maxOccurences": 0,
  • "displayModel": {
    },
  • "operatorName": "string",
  • "sourceEventTypeIds": [
    ],
  • "sourceProfileTypeIds": [
    ]
}

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/properties/{propertyId}

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
propertyId
required
string <uuid>

Responses

ProfileTypes

/profile/v1.0/tenants/{tenantId}/profiletypes

path Parameters
tenantId
required
string <uuid>
query Parameters
skip
integer <int32>
take
integer <int32>
Default: 2147483647

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes

path Parameters
tenantId
required
string <uuid>
Request Body schema:
id
string <uuid>
isMain
boolean
name
string or null
description
string or null
Array of objects or null (CM.Data.Core.Profiles.Api.Models.ApiProfileTypeProperty)

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isMain": true,
  • "name": "string",
  • "description": "string",
  • "properties": [
    ]
}

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/main

path Parameters
tenantId
required
string <uuid>

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/children

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/eventtypes/{eventTypeId}/sessiontype

path Parameters
tenantId
required
string <uuid>
eventTypeId
required
string <uuid>

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
Request Body schema:
id
string <uuid>
isMain
boolean
name
string or null
description
string or null
Array of objects or null (CM.Data.Core.Profiles.Api.Models.ApiProfileTypeProperty)

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isMain": true,
  • "name": "string",
  • "description": "string",
  • "properties": [
    ]
}

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>

Responses

Segments

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/segments

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
query Parameters
skip
integer <int32>
take
integer <int32>
Default: 2147483647
filter
string

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/segments/{segmentId}

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
segmentId
required
string <uuid>

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/segments/_count

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>

Responses

Response samples

Content type
No sample

/profile/v1.0/tenants/{tenantId}/profiletypes/{profileTypeId}/segments/{segmentId}/_rename

path Parameters
tenantId
required
string <uuid>
profileTypeId
required
string <uuid>
segmentId
required
string <uuid>
Request Body schema:
id
string or null <uuid>
name
string or null
description
string or null
object (CM.Data.QueryLanguage.Tree)
consentPurposeId
string or null <uuid>
shouldBeSynchronizedToAddressBook
boolean
addressBookStatus
integer <int32> (CM.Data.Core.Profiles.Api.Models.Enums.ApiSegmentAddressBookStatus)
Enum: 0 1 2

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "queryTree": {
    },
  • "consentPurposeId": "5072b987-55e0-47e5-8d6f-3aff0c86970a",
  • "shouldBeSynchronizedToAddressBook": true,
  • "addressBookStatus": 0
}

Response samples

Content type
No sample

Workflows

/profile/v1.0/tenants/{tenantId}/workflows/_count

path Parameters
tenantId
required
string <uuid>

Responses

/profile/v1.0/tenants/{tenantId}/workflows/_query

path Parameters
tenantId
required
string <uuid>
query Parameters
skip
integer <int32>
take
integer <int32>
Request Body schema:
nameContains
string or null
enabledStatus
integer <int32> (CM.Data.Core.Workflows.Api.Models.ApiWorkflowSearchEnabledStatus)
Enum: 0 1 2 3
sortOn
integer <int32> (CM.Data.Core.Workflows.Api.Models.ApiWorkflowSortOrder)
Enum: 0 1 2
reverse
boolean or null
favorites
integer <int32> (CM.Data.Core.Workflows.Api.Models.ApiWorkflowFavoriteFilter)
Enum: 0 1 2

Responses

Request samples

Content type
{
  • "nameContains": "string",
  • "enabledStatus": 0,
  • "sortOn": 0,
  • "reverse": true,
  • "favorites": 0
}

/profile/v1.0/tenants/{tenantId}/workflows/{id}

path Parameters
tenantId
required
string <uuid>
id
required
string <uuid>

Responses

/profile/v1.0/tenants/{tenantId}/workflows/{id}

path Parameters
tenantId
required
string <uuid>
id
required
string <uuid>
Request Body schema:
id
string <uuid>
name
string or null
consentPurposeId
string or null <uuid>
Array of objects or null (CM.Data.Core.Workflows.Api.Models.Steps.ApiStep)
object (CM.Data.Core.Workflows.Api.Models.ApiGoal)
enabled
boolean
isReady
boolean
createdBy
string or null <uuid>
createdOn
string or null <date-time>
modifiedBy
string or null <uuid>
modifiedOn
string or null <date-time>
isFavorite
boolean or null

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "consentPurposeId": "5072b987-55e0-47e5-8d6f-3aff0c86970a",
  • "steps": [
    ],
  • "goal": {
    },
  • "enabled": true,
  • "isReady": true,
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "modifiedBy": "07ff0787-1af5-4fc4-9832-7aaeaa962a5e",
  • "modifiedOn": "2019-08-24T14:15:22Z",
  • "isFavorite": true
}

/profile/v1.0/tenants/{tenantId}/workflows/{id}

path Parameters
tenantId
required
string <uuid>
id
required
string <uuid>

Responses

/profile/v1.0/tenants/{tenantId}/workflows/{id}/_copy

path Parameters
tenantId
required
string <uuid>
id
required
string <uuid>

Responses

/profile/v1.0/tenants/{tenantId}/workflows/{id}/_manual

path Parameters
tenantId
required
string <uuid>
id
required
string <uuid>

Responses

/profile/v1.0/tenants/{tenantId}/workflows/{id}/_enable

path Parameters
tenantId
required
string <uuid>
id
required
string <uuid>

Responses

/profile/v1.0/tenants/{tenantId}/workflows/{id}/_disable

path Parameters
tenantId
required
string <uuid>
id
required
string <uuid>

Responses

/profile/v1.0/tenants/{tenantId}/workflows/{id}/_favorite

path Parameters
tenantId
required
string <uuid>
id
required
string <uuid>

Responses

/profile/v1.0/tenants/{tenantId}/workflows/{id}/_unfavorite

path Parameters
tenantId
required
string <uuid>
id
required
string <uuid>

Responses