Download OpenAPI specification:Download
| tenantId required | string <uuid> |
| profileTypeId required | string <uuid> |
| profileId required | string |
| take | integer <int32> |
| cursor | string |
| search | string |
| tenantId required | string <uuid> |
| profileTypeId required | string <uuid> |
| profileId required | string |
| take required | integer <int32> Default: 25 |
| tenantId required | string <uuid> |
| skip | integer <int32> |
| take | integer <int32> Default: 2147483647 |
| eventTypeIds | Array of strings or null <uuid> [ items <uuid > ] |
{- "eventTypeIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}| tenantId required | string <uuid> |
| eventTypeIds | Array of strings or null <uuid> [ items <uuid > ] |
{- "eventTypeIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}| tenantId required | string <uuid> |
| skip | integer <int32> |
| take | integer <int32> Default: 2147483647 |
| isMapped | boolean Default: false |
| isUnmapped | boolean Default: false |
| dependencyKey | string <uuid> |
| tenantId required | string <uuid> |
| id | string <uuid> |
| name | string or null |
Array of objects or null (CM.Data.Core.Profiles.Api.Models.ApiEventTypeProperty) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "properties": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "priority": 0,
- "type": 0,
- "isOptional": true,
- "isNotIndexed": true
}
]
}| tenantId required | string <uuid> |
| eventTypeId required | string <uuid> |
| ignoreDependencyLinkValidation | boolean Default: false |
| id | string <uuid> |
| name | string or null |
Array of objects or null (CM.Data.Core.Profiles.Api.Models.ApiEventTypeProperty) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "properties": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "priority": 0,
- "type": 0,
- "isOptional": true,
- "isNotIndexed": true
}
]
}| tenantId required | string <uuid> |
| eventTypeId required | string <uuid> |
| id | string <uuid> |
| name | string or null |
Array of objects or null (CM.Data.Core.Profiles.Api.Models.ApiEventTypeProperty) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "properties": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "priority": 0,
- "type": 0,
- "isOptional": true,
- "isNotIndexed": true
}
]
}| tenantId required | string <uuid> |
| profileTypeId required | string <uuid> |
| skip | integer <int32> |
| take | integer <int32> Default: 2147483647 |
| sortOn | string |
| reverse | boolean Default: false |
| tenantId required | string <uuid> |
| profileTypeId required | string <uuid> |
| skip | integer <int32> |
| take | integer <int32> Default: 2147483647 |
| sortOn | string |
| reverse | boolean Default: false |
object (CM.Data.QueryLanguage.Nodes.Node) | |
object (CM.Data.QueryLanguage.Nodes.Node) | |
{- "root": { }
}| tenantId required | string <uuid> |
| profileTypeId required | string <uuid> |
object (CM.Data.QueryLanguage.Nodes.Node) | |
object (CM.Data.QueryLanguage.Nodes.Node) | |
{- "root": { }
}| tenantId required | string <uuid> |
| profileTypeId required | string <uuid> |
| segmentId required | string <uuid> |
| skip | integer <int32> |
| take | integer <int32> Default: 2147483647 |
| sortOn | string |
| reverse | boolean Default: false |
| tenantId required | string <uuid> |
| profileTypeId required | string <uuid> |
object (CM.Data.QueryLanguage.Nodes.Node) | |
object (CM.Data.QueryLanguage.Nodes.Node) | |
{- "root": { }
}| tenantId required | string <uuid> |
| profileTypeId required | string <uuid> |
| 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 > ] |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": 0,
- "possibleOriginTypes": [
- 0
], - "isKey": true,
- "externalKey": 0,
- "isNotIndexed": true,
- "maxOccurences": 0,
- "displayModel": {
- "index": 0,
- "isVisible": true
}, - "operatorName": "string",
- "sourceEventTypeIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "sourceProfileTypeIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}| tenantId required | string <uuid> |
| profileTypeId required | string <uuid> |
| propertyId required | string <uuid> |
| 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 > ] |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": 0,
- "possibleOriginTypes": [
- 0
], - "isKey": true,
- "externalKey": 0,
- "isNotIndexed": true,
- "maxOccurences": 0,
- "displayModel": {
- "index": 0,
- "isVisible": true
}, - "operatorName": "string",
- "sourceEventTypeIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "sourceProfileTypeIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}| tenantId required | string <uuid> |
| 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) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "isMain": true,
- "name": "string",
- "description": "string",
- "properties": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": 0,
- "possibleOriginTypes": [
- 0
], - "isKey": true,
- "externalKey": 0,
- "isNotIndexed": true,
- "maxOccurences": 0,
- "displayModel": {
- "index": 0,
- "isVisible": true
}, - "operatorName": "string",
- "sourceEventTypeIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "sourceProfileTypeIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]
}| tenantId required | string <uuid> |
| profileTypeId required | string <uuid> |
| 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) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "isMain": true,
- "name": "string",
- "description": "string",
- "properties": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": 0,
- "possibleOriginTypes": [
- 0
], - "isKey": true,
- "externalKey": 0,
- "isNotIndexed": true,
- "maxOccurences": 0,
- "displayModel": {
- "index": 0,
- "isVisible": true
}, - "operatorName": "string",
- "sourceEventTypeIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "sourceProfileTypeIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]
}| tenantId required | string <uuid> |
| profileTypeId required | string <uuid> |
| segmentId required | string <uuid> |
| 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 |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "queryTree": {
- "root": { }
}, - "consentPurposeId": "5072b987-55e0-47e5-8d6f-3aff0c86970a",
- "shouldBeSynchronizedToAddressBook": true,
- "addressBookStatus": 0
}| tenantId required | string <uuid> |
| skip | integer <int32> |
| take | integer <int32> |
| 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 |
{- "nameContains": "string",
- "enabledStatus": 0,
- "sortOn": 0,
- "reverse": true,
- "favorites": 0
}| tenantId required | string <uuid> |
| id required | string <uuid> |
| 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 |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "consentPurposeId": "5072b987-55e0-47e5-8d6f-3aff0c86970a",
- "steps": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "nextStepId": "142c7a6d-2f1c-4ddc-9f1b-2ef0d2239d82",
- "summary": "string"
}
], - "goal": {
- "eventTypeId": "f899218d-6f2c-4300-8a70-a6910536041b",
- "propertyName": "string",
- "value": "string",
- "stopWorkflowWhenGoalIsMet": true
}, - "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
}