Asset Management (Nov 5, 2024, 1:06:06 PM)

Download OpenAPI specification:Download

Welcome to Synerise API Reference! We hope that you'll enjoy your stay here.

If you need help with our services, feel free to contact us at support@synerise.com.

Authentication

JWT

Synerise uses JSON Web Token (JWT) as the authorization method. The token is generated by the auth/login endpoint. You need to include it in the Authorization header of your requests, with a Bearer prefix. See this simplified example of a call:

curl -X GET https://api.synerise.com/v4/clients \
-H 'Accept: application/json' \
-H 'Api-Version: 4.4' \
-H 'Authorization: Bearer eyJhbGciOiJSzZXIiLCJjdGQiOjE1NTI0NjMzMjg4NjIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsIm5tZSI' \
-H 'Content-Type: application/json'

Remember to include a space between Bearer and the token.

The token is valid for one hour (unless configured differently). You can request a refreshed key for the session by using the auth/refresh endpoint before the current token expires.

You can verify your JWT signature by using the public key.

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

TrackerKey

Authorization by tracker key sent in a token query parameter. This may be the same key as used in the tracking code of the website. For details, see this article: https://help.synerise.com/developers/web/installation-and-configuration/#creating-a-tracking-code.

Security Scheme Type	API Key
Query parameter name:	token

Authorization

Methods to authorize and obtain JWT token required by our API endpoints

Log in as User

Authenticate as a User.

Note: To perform operations within a Workspace, you must select a Workspace.

This method does not require a Synerise authorization token.

Request Body schema: application/json

username required	string The login (email address) of the user
password required	string The user's password
deviceId	string Identifier of user's current device
externalProviderToken	string
externalProviderType	string Value: "GOOGLE"

Responses

Request samples

Content type

application/json

{"username": "string",
"password": "string",
"deviceId": "string",
"externalProviderToken": "string",
"externalProviderType": "GOOGLE"
}

Response samples

200

Content type

application/json

{"consumer": {"type": "USER",
"businessProfileId": 0,
"name": "string",
"id": 0,
"authorities": ["string"
],
"roles": "string"
},
"token": "string"
}

Verify User multi-factor authentication

Authenticate as a User with multi-factor authentication.

Note: To perform operations within a Workspace, you must select a Workspace.

API consumer who can use this method: Synerise User
This method is available to all authenticated users, before and after multi-factor authentication is confirmed.

Authorizations:

JWT

query Parameters

mfaType

required

string

Enum: "TOTP_AUTHENTICATOR" "EMAIL"

Type of multi-factor authentication

Request Body schema: application/json

verificationCode required	string Multi-factor verification code
deviceId	string
externalProviderToken	string
externalProviderType	string Value: "GOOGLE"

Responses

Request samples

Content type

application/json

{"verificationCode": "string",
"deviceId": "string",
"externalProviderToken": "string",
"externalProviderType": "GOOGLE"
}

Response samples

200

Content type

application/json

{"consumer": {"type": "USER",
"businessProfileId": 0,
"name": "string",
"id": 0,
"authorities": ["string"
],
"roles": "string"
},
"token": "string"
}

Select Workspace

After logging in as a User, select a Workspace where you want to perform operations.

API consumer who can use this method: Synerise User
This method is available to all fully-authenticated users (multifactor confirmation required, if enabled).

Authorizations:

JWT

path Parameters

businessProfileUUID

required

string <uuid>

UUID of the workspace

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/uauth/auth/login/user/profile/%7BbusinessProfileUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
423

Content type

application/json

{"consumer": {"type": "USER",
"businessProfileId": 0,
"name": "string",
"id": 0,
"authorities": ["string"
],
"roles": "string"
},
"token": "string"
}

Get Workspaces

Retrieve a list of Workspaces available to the user.

API consumer who can use this method: Synerise User
This method is available to all fully-authenticated users (multifactor confirmation required, if enabled).

Authorizations:

JWT

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/uauth/business-profile/ 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

[{"businessProfileGuid": "string",
"logo": "string",
"name": "string",
"id": 0,
"created": "2019-08-24T14:15:22Z",
"subdomain": "string",
"ipRestricted": true,
"mfaRequired": true
}
]

Get current Workspace

Retrieve information about the currently selected workspace.

API consumer who can use this method: Synerise User
This method is available to all fully-authenticated users (multifactor confirmation required, if enabled).

Authorizations:

JWT

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/uauth/business-profile/current 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"selected": true,
"data": {"id": 0,
"name": "string",
"logo": "string",
"businessProfileGuid": "string",
"created": "2019-08-24T14:15:22Z",
"subdomain": "string",
"ipRestriction": "OFF",
"mfaRestriction": "OFF"
}
}

Log in as Workspace

Obtain a new Workspace JWT Token.

This method does not require a Synerise authorization token.

Request Body schema: application/json

apiKey

required

string

Workspace API key

WARNING: Workspace API keys can be used to access all customer data and manage the workspace. They should only be used for server-to-server communication in integrations. DO NOT use workspace API keys in your mobile applications or websites.

Responses

Request samples

Content type

application/json

{"apiKey": "64c09614-1b2a-42f7-804d-f647243eb1ab"
}

Response samples

200
400
401

Content type

application/json

{"token": "string"
}

Refresh a Profile token

Retrieve a refreshed JWT Token to prolong the session.

The current token must still be active at the time of the request.

API consumers who can use this method: Profile (formerly client), Anonymous profile (formerly client)
This method does not require a Synerise authorization token.

Authorizations:

JWT

Request Body schema: application/json

apiKey

required

string

Profile (formerly "Client") API key

Responses

Request samples

Content type

application/json

{"apiKey": "string"
}

Response samples

200
401

Content type

application/json

{"token": "string",
"expiration": 1649283173,
"created": 1649277173668,
"origin": "SYNERISE",
"customId": "card123",
"realm": "client"
}

Authenticate as Profile

Obtain a new JWT for a Profile. If an account for the Profile does not exist and the identityProvider is different than SYNERISE, this request creates an account.

This method does not require a Synerise authorization token.

Request Body schema: application/json

apiKey required	string Profile (formerly "Client") API key
identityProvider required	string Enum: "SYNERISE" "FACEBOOK" "OAUTH" "APPLE" "GOOGLE" "UNKNOWN" The identity provider.
identityProviderToken	string Third-party authentication token used to authenticate with the Identity Provider. Required if `identityProvider` is different than `SYNERISE`.
email	string Profile email. Required if `identityProvider` is `SYNERISE` and email is the unique identifier (default setting).
customId	any Profile customId. Required if `identityProvider` is `SYNERISE` and customId is the unique identifier (see https://hub.synerise.com/docs/settings/configuration/non-unique-emails/).
password	string Profile password. Required if `identityProvider` is `SYNERISE`.
uuid	string Profile UUID. Required if `identityProvider` is `SYNERISE`.
deviceId	string Unique Android or iOS device ID
	object This object contains the marketing agreements of the Profile. You can also pass the values as strings (`"true"`;`"True"`/`"false"`;`"False"`) or integers (`1` for true and `0` for false).
	object This object contains custom attributes that can have any name (except for reserved attributes, see warning below) and data type, as required by your integration. The attribute names can't include any characters that match the pattern (ECMA flavor): `/[\r\n\u2028\u2029\u00AD\u0000\uFE00-\uFE0F]/` String values: can't include variation selectors (`[\uFE00-\uFE0F]`), unless there are other characters in the string. can't include the "null" control character (`\u0000`) If you want to send a date/time attribute for use in analytics, take the following into account: The date/time should be formatted according to ISO 8601. The time zone of the workspace affects dates/times in the attributes that DON'T have a defined timezone. Example: `2023-10-09T12:00:00` doesn't have a timezone indicator and will be considered as a time in the workspace's time zone. `2023-10-09T12:00:00+02:00` has a timezone indicator (`+02:00`), so the timezone of the workspace doesn't affect it. `2023-10-09T12:00:00Z` is a time in the UTC time zone (denoted by the `Z` at the end), so the timezone of the workspace doesn't affect it. WARNING: Some attributes are reserved and cannot be sent. If you send them, they are ignored. Click to expand the list of reserved attributes `email` `clientId` `phone` `customId` `uuid` `firstName` `lastName` `displayName` `company` `address` `city` `province` `zipCode` `countryCode` `birthDate` `sex` `avatarUrl` `anonymous` `agreements` `tags` `businessProfileId` `time` `ip` `source` `newsletter_agreement` `custom_identify` `firstname` `lastname` `created` `updated` `last_activity_date` `birthdate` `external_avatar_url` `displayname` `receive_smses` `receive_push_messages` `receive_webpush_messages` `receive_btooth_messages` `receive_rfid_messages` `receive_wifi_messages` `confirmation_hash` `ownerId` `zipCode` `anonymous_type` `country_id` `geo_loc_city` `geo_loc_country` `geo_loc_as` `geo_loc_country_code` `geo_loc_isp` `geo_loc_lat` `geo_loc_lon` `geo_loc_org` `geo_loc_query` `geo_loc_region` `geo_loc_region_name` `geo_loc_status` `geo_loc_timezone` `geo_loc_zip` `club_card_id` `type` `confirmed` `facebookId` `status`
tags	Array of strings Tags can be used to group profiles. Tag names (strings): can't include variation selectors (`[\uFE00-\uFE0F]`), unless there are other characters in the string. can't include the "null" control character (`\u0000`)

Responses

Request samples

Content type

application/json

{"apiKey": "string",
"identityProvider": "SYNERISE",
"identityProviderToken": "string",
"email": "string",
"customId": null,
"password": "string",
"uuid": "string",
"deviceId": "string",
"agreements": {"email": false,
"sms": false,
"push": false,
"webPush": false,
"bluetooth": false,
"rfid": false,
"wifi": false
},
"attributes": {"property1": null,
"property2": null
},
"tags": ["string"
]
}

Response samples

Content type

application/json

{"token": "eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk"
}

Authenticate Profile with a server

Obtain a new JWT for a Profile. This method is designed to be used from a backend server that handles login requests and communicates with Synerise to execute them.
If an account for the Profile does not exist and the identityProvider is different than SYNERISE, this request creates an account.

API consumer who can use this method: Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SAUTH_SERVER_LOGIN_CLIENT_CREATE

Request Body schema: application/json

ipAddress required	string The IP address of the client device that is logging in.
apiKey required	string Profile (formerly "Client") API key
identityProvider required	string Enum: "SYNERISE" "FACEBOOK" "OAUTH" "APPLE" "GOOGLE" "UNKNOWN" The identity provider.
identityProviderToken	string Third-party authentication token used to authenticate with the Identity Provider. Required if `identityProvider` is different than `SYNERISE`.
email	string Profile email. Required if `identityProvider` is `SYNERISE` and email is the unique identifier (default setting).
customId	any Profile customId. Required if `identityProvider` is `SYNERISE` and customId is the unique identifier (see https://hub.synerise.com/docs/settings/configuration/non-unique-emails/).
password	string Profile password. Required if `identityProvider` is `SYNERISE`.
uuid	string Profile UUID. Required if `identityProvider` is `SYNERISE`.
deviceId	string Unique Android or iOS device ID
	object This object contains the marketing agreements of the Profile. You can also pass the values as strings (`"true"`;`"True"`/`"false"`;`"False"`) or integers (`1` for true and `0` for false).
	object This object contains custom attributes that can have any name (except for reserved attributes, see warning below) and data type, as required by your integration. The attribute names can't include any characters that match the pattern (ECMA flavor): `/[\r\n\u2028\u2029\u00AD\u0000\uFE00-\uFE0F]/` String values: can't include variation selectors (`[\uFE00-\uFE0F]`), unless there are other characters in the string. can't include the "null" control character (`\u0000`) If you want to send a date/time attribute for use in analytics, take the following into account: The date/time should be formatted according to ISO 8601. The time zone of the workspace affects dates/times in the attributes that DON'T have a defined timezone. Example: `2023-10-09T12:00:00` doesn't have a timezone indicator and will be considered as a time in the workspace's time zone. `2023-10-09T12:00:00+02:00` has a timezone indicator (`+02:00`), so the timezone of the workspace doesn't affect it. `2023-10-09T12:00:00Z` is a time in the UTC time zone (denoted by the `Z` at the end), so the timezone of the workspace doesn't affect it. WARNING: Some attributes are reserved and cannot be sent. If you send them, they are ignored. Click to expand the list of reserved attributes `email` `clientId` `phone` `customId` `uuid` `firstName` `lastName` `displayName` `company` `address` `city` `province` `zipCode` `countryCode` `birthDate` `sex` `avatarUrl` `anonymous` `agreements` `tags` `businessProfileId` `time` `ip` `source` `newsletter_agreement` `custom_identify` `firstname` `lastname` `created` `updated` `last_activity_date` `birthdate` `external_avatar_url` `displayname` `receive_smses` `receive_push_messages` `receive_webpush_messages` `receive_btooth_messages` `receive_rfid_messages` `receive_wifi_messages` `confirmation_hash` `ownerId` `zipCode` `anonymous_type` `country_id` `geo_loc_city` `geo_loc_country` `geo_loc_as` `geo_loc_country_code` `geo_loc_isp` `geo_loc_lat` `geo_loc_lon` `geo_loc_org` `geo_loc_query` `geo_loc_region` `geo_loc_region_name` `geo_loc_status` `geo_loc_timezone` `geo_loc_zip` `club_card_id` `type` `confirmed` `facebookId` `status`
tags	Array of strings Tags can be used to group profiles. Tag names (strings): can't include variation selectors (`[\uFE00-\uFE0F]`), unless there are other characters in the string. can't include the "null" control character (`\u0000`)

Responses

Request samples

Content type

application/json

{"ipAddress": "string",
"apiKey": "string",
"identityProvider": "SYNERISE",
"identityProviderToken": "string",
"email": "string",
"customId": null,
"password": "string",
"uuid": "string",
"deviceId": "string",
"agreements": {"email": false,
"sms": false,
"push": false,
"webPush": false,
"bluetooth": false,
"rfid": false,
"wifi": false
},
"attributes": {"property1": null,
"property2": null
},
"tags": ["string"
]
}

Response samples

Content type

application/json

{"token": "eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk"
}

Authenticate as Profile (conditional)

Obtain a new JWT token for a Profile.

If the account does not exist, an account is not created.
If any additional conditions are required for logging in, the response is HTTP200 and lists the conditions.
Note that using this endpoint requires authenticating as an anonymous Profile first.
This method does not require a Synerise authorization token.

Authorizations:

JWT

Request Body schema: application/json

apiKey required	string Profile (formerly "Client") API key
identityProvider required	string Enum: "SYNERISE" "FACEBOOK" "OAUTH" "APPLE" "GOOGLE" "UNKNOWN" The identity provider.
identityProviderToken	string Third-party authentication token used to authenticate with the Identity Provider. Required if `identityProvider` is different than `SYNERISE`.
email	string Profile email. Required if `identityProvider` is `SYNERISE` and email is the unique identifier (default setting).
customId	any Profile customId. Required if `identityProvider` is `SYNERISE` and customId is the unique identifier (see https://hub.synerise.com/docs/settings/configuration/non-unique-emails/).
password	string Profile password. Required if `identityProvider` is `SYNERISE`.
uuid	string Profile UUID. Required if `identityProvider` is `SYNERISE`.
deviceId	string Unique Android or iOS device ID
	object This object contains the marketing agreements of the Profile. You can also pass the values as strings (`"true"`;`"True"`/`"false"`;`"False"`) or integers (`1` for true and `0` for false).
	object This object contains custom attributes that can have any name (except for reserved attributes, see warning below) and data type, as required by your integration. The attribute names can't include any characters that match the pattern (ECMA flavor): `/[\r\n\u2028\u2029\u00AD\u0000\uFE00-\uFE0F]/` String values: can't include variation selectors (`[\uFE00-\uFE0F]`), unless there are other characters in the string. can't include the "null" control character (`\u0000`) If you want to send a date/time attribute for use in analytics, take the following into account: The date/time should be formatted according to ISO 8601. The time zone of the workspace affects dates/times in the attributes that DON'T have a defined timezone. Example: `2023-10-09T12:00:00` doesn't have a timezone indicator and will be considered as a time in the workspace's time zone. `2023-10-09T12:00:00+02:00` has a timezone indicator (`+02:00`), so the timezone of the workspace doesn't affect it. `2023-10-09T12:00:00Z` is a time in the UTC time zone (denoted by the `Z` at the end), so the timezone of the workspace doesn't affect it. WARNING: Some attributes are reserved and cannot be sent. If you send them, they are ignored. Click to expand the list of reserved attributes `email` `clientId` `phone` `customId` `uuid` `firstName` `lastName` `displayName` `company` `address` `city` `province` `zipCode` `countryCode` `birthDate` `sex` `avatarUrl` `anonymous` `agreements` `tags` `businessProfileId` `time` `ip` `source` `newsletter_agreement` `custom_identify` `firstname` `lastname` `created` `updated` `last_activity_date` `birthdate` `external_avatar_url` `displayname` `receive_smses` `receive_push_messages` `receive_webpush_messages` `receive_btooth_messages` `receive_rfid_messages` `receive_wifi_messages` `confirmation_hash` `ownerId` `zipCode` `anonymous_type` `country_id` `geo_loc_city` `geo_loc_country` `geo_loc_as` `geo_loc_country_code` `geo_loc_isp` `geo_loc_lat` `geo_loc_lon` `geo_loc_org` `geo_loc_query` `geo_loc_region` `geo_loc_region_name` `geo_loc_status` `geo_loc_timezone` `geo_loc_zip` `club_card_id` `type` `confirmed` `facebookId` `status`
tags	Array of strings Tags can be used to group profiles. Tag names (strings): can't include variation selectors (`[\uFE00-\uFE0F]`), unless there are other characters in the string. can't include the "null" control character (`\u0000`)

Responses

Request samples

Content type

application/json

{"apiKey": "string",
"identityProvider": "SYNERISE",
"identityProviderToken": "string",
"email": "string",
"customId": null,
"password": "string",
"uuid": "string",
"deviceId": "string",
"agreements": {"email": false,
"sms": false,
"push": false,
"webPush": false,
"bluetooth": false,
"rfid": false,
"wifi": false
},
"attributes": {"property1": null,
"property2": null
},
"tags": ["string"
]
}

Response samples

Content type

application/json

{"conditions": ["string"
],
"status": "SUCCESS",
"token": "string",
"expiration": 1649283173,
"created": 1649277173668,
"origin": "SYNERISE",
"customId": "card123",
"realm": "client"
}

Authenticate anonymously

Obtain a new JWT for an anonymous Profile. The token can be used and refreshed in the same way as tokens of registered Profiles.

This method does not require a Synerise authorization token.

Request Body schema: application/json

apiKey required	string Profile (formerly "Client") API key
uuid required	string UUID of the Profile. It is a unique identifier. The value can't include any characters that match the pattern (ECMA flavor): `/([\uD800-\uDBFF][\uDC00-\uDFFF])\|([\r\n\u2028\u2029\u00AD]\|[\uFE00-\uFE0F]\|[\u0000])/`
deviceId	string Unique iOS or Android device identifier.

Responses

Request samples

Content type

application/json

{"apiKey": "string",
"uuid": "07243772-008a-42e1-ba37-c3807cebde8f",
"deviceId": "string"
}

Response samples

200
401

Content type

application/json

{"token": "eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk"
}

Documents

Manage JSON documents that can be implemented directly in your Applications

Generate document (slug)

Generate a document. Inserts are processed. If an insert can't be processed, the returned content is empty.

If the document includes inserts with a context (for example, {% customer param %}), you must authenticate the request with a JWT that provides the context.

If you want to authenticate with a JWT that doesn't provide the required context, you can use the POST /v2/documents/{slug}/generate endpoint to provide the parameter values in the request body.

IMPORTANT: When the request's context is a Workspace or Synerise User JWT, only documents with the audience set to ALL ("Everyone" in the Synerise Web Application) can be generated.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User, Profile (formerly client), Anonymous profile (formerly client)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

slug

required

string[a-z0-9]+(?:-[a-z0-9]+)*

Slug of the document

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/documents/%7Bslug%7D/generate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "basket",
"schema": "containers",
"content": {"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": {"uuid": "772d94f7-a604-409a-bfa9-24a64b8a5051",
"slug": "apple",
"schema": "fruit",
"content": {"color": "red"
}
}
}
}

Generate document (slug)

Generate a document. Inserts are processed. If an insert can't be processed, the returned content is empty.

IMPORTANT: When the request's context is a Workspace or Synerise User JWT, only documents with the audience set to ALL ("Everyone" in the Synerise Web Application) can be generated.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User, Profile (formerly client), Anonymous profile (formerly client)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

slug

required

string[a-z0-9]+(?:-[a-z0-9]+)*

Slug of the document

Request Body schema: application/json

string or number

If you are generating the resource with a context that doesn't have the data for inserts in the resource (for example, a document has a {% customer param %} insert, but you're authenticated with a workspace JWT, so the customer context can't be extracted from the JWT), you can include the parameters in the request body. If an insert can't be processed, the returned content is empty.

Usage example: if the {% customer firstName %} insert is used in a document, you can pass its value by sending "customer.firstName": "Joe"

Because inserts are always encapsulated with quotation marks, inserts that return a number or a boolean value return it as a string.

Responses

Request samples

Content type

application/json

{"customer.firstName": "Joe"
}

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "basket",
"schema": "containers",
"content": {"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": {"uuid": "772d94f7-a604-409a-bfa9-24a64b8a5051",
"slug": "apple",
"schema": "fruit",
"content": {"color": "red"
}
}
}
}

Generate document (document UUID)

Generate a document. Inserts are processed. If an insert can't be processed, the returned content is empty.

IMPORTANT: When the request's context is a Workspace or Synerise User JWT, only documents with the audience set to ALL ("Everyone" in the Synerise Web Application) can be generated.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User, Profile (formerly client), Anonymous profile (formerly client)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Request Body schema: application/json

string or number

If you are generating the resource with a context that doesn't have the data for inserts in the resource (for example, a document has a {% customer param %} insert, but you're authenticated with a workspace JWT, so the customer context can't be extracted from the JWT), you can include the parameters in the request body. If an insert can't be processed, the returned content is empty.

Usage example: if the {% customer firstName %} insert is used in a document, you can pass its value by sending "customer.firstName": "Joe"

Because inserts are always encapsulated with quotation marks, inserts that return a number or a boolean value return it as a string.

Responses

Request samples

Content type

application/json

{"customer.firstName": "Joe"
}

Response samples

Content type

application/json

"string"

Create document

Create a new document.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

name required	string Document name
priority required	integer <int32> <= 100 Priority of the document
required	object or string Content of the document. It can contain inserts.
slug required	string[a-z0-9]+(?:-[a-z0-9]+)* Slug of the document
schema	string Schema of the document (called "Type" in the Synerise Web Application)
groupId	string <uuid> UUID of a document group. Groups can be used to organize documents. When creating a screen view campaign, entire groups can be included instead of selecting each document separately.
required	object The profiles (clients) which have access to this resource
	object Configuration of the schedule
directoryId required	string <uuid> UUID of a directory. Directories can be used to organize documents and screen views for display in the Synerise Web Application. If you want to organize documents for screen view campaigns, use document groups instead. If you want to organize screen views for display, use screen view feeds instead.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"priority": 100,
"content": {"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": "{% document exampleslug %}"
},
"slug": "basket",
"schema": "containers",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"schedule": {"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"endType": "NEVER",
"parts": [{"startDay": 1,
"startTime": "08:18:03",
"endDay": 1,
"endTime": "44283"
}
],
"periodType": "ENTIRE",
"startDate": "2019-08-24T14:15:22Z",
"startType": "NOW",
"timezone": "Europe/Warsaw"
},
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"priority": 100,
"content": {"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": "{% document exampleslug %}"
},
"slug": "basket",
"schema": "containers",
"scheduled": true,
"status": "DRAFT",
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"author": {"id": 0,
"name": "string",
"avatar": "string"
},
"directory": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
},
"group": {"id": "43c97b25-4a10-45d0-99b7-d472eea2bb24",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"nr": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Initialize document

Create a new document. It is created as a blank, without any conditions.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

name	string If no name is provided, defaults to "Unnamed document" or Screen View Campaign" (depending on what you are initializing).
directory	string <uuid> If no directory is provided, the default directory is used.

Responses

Request samples

Content type

application/json

{"name": "string",
"directory": "5277859d-f92c-478c-acab-7680a97fea68"
}

Response samples

Content type

application/json

{"docId": "b394169a-e7cd-41ad-9e47-a6d4a11d664b",
"name": "string",
"status": "DRAFT",
"authorId": 0,
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18",
"scheduled": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Add audience to document

Define the audience for a document.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Request Body schema: application/json

targetType required	string Enum: "SEGMENT" "QUERY" "ALL" The method of defining the audience: SEGMENT sets the audience to segmentations whose UUIDs are provided in `segments` QUERY sets the audience to an analytics query provided in `query` ALL sets the audience to all profiles in the database
segments	Array of strings An array of segmentation IDs. Used with `targetType: SEGMENT`
query	string Stringified `analysis` object for the segmentation analytics engine. Used with `targetType: QUERY`. Refer to the Analytics API Reference.

Responses

Request samples

Payload

Content type

application/json

{"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
}

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Add content to document

Add content and configuration (priority, schema, and so on) to a document.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Request Body schema: application/json

priority required	integer <int32> <= 100 Priority of the document
required	object JSON structure of the document
slug required	string[a-z0-9]+(?:-[a-z0-9]+)* Slug of the document
schema required	string Schema of the document (called "Type" in the Synerise Web Application)
groupId	string <uuid> UUID of the group

Responses

Request samples

Content type

application/json

{"priority": 100,
"content": {"property1": null,
"property2": null
},
"slug": "basket",
"schema": "containers",
"groupId": "43c97b25-4a10-45d0-99b7-d472eea2bb24"
}

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Rename document

Rename a document.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Request Body schema: application/json

string

New name for the document

Responses

Request samples

Content type

application/json

"string"

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Update priority in document

Update priority in a document.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Request Body schema: application/json

integer <int32>

Responses

Request samples

Content type

application/json

0

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Preview document content for a profile

Preview document content in context of a profile. Inserts are processed. If an insert can't be processed, the returned content is empty.

This method should not be used in production implementations, its purpose is to test the content. Use the "generate document" endpoints for implementation.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

identifierType

required

string

Enum: "id" "uuid" "email" "custom_identify"

Type of the profile identifier. The value is sent in identifierValue in the request body.

Request Body schema: application/json

identifierValue required	string Value of the selected identifier. Note that IDs must also be sent as strings.
required	object or string Content of the document. It can contain inserts.
	object Additional parameters

Responses

Request samples

Content type

application/json

{"identifierValue": "string",
"content": {"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": "{% document exampleslug %}"
},
"params": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

"string"

Generate document for a profile

Generate a document in context of a profile. Inserts are processed. If an insert can't be processed, the returned content is empty.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentIdentifier required	string UUID or slug of the document
identifierType required	string Enum: "id" "uuid" "email" "custom_identify" Type of the profile identifier. The value is sent in `identifierValue` in the request body.

Request Body schema: application/json

identifierValue required	string Value of the selected identifier. Note that IDs must also be sent as strings.
	object Additional parameters

Responses

Request samples

Content type

application/json

{"identifierValue": "string",
"params": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

"string"

List grouped documents

Retrieve a group or groups of documents with information about the documents in those groups and relations between them. The response is an array of arrays (groups) of objects (documents).

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

Array

string <uuid>

UUID of a document group

Responses

Request samples

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"status": "DRAFT",
"priority": 100,
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"status": "DRAFT",
"priority": 100,
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"status": "DRAFT",
"priority": 100,
"children": [{"id": null,
"name": null,
"status": null,
"priority": null,
"children": [ ]
}
]
}
]
}
]
}
]
}
]

List documents

Returns a paginated list of documents.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

query Parameters

page	number <int32> >= 1 Default: 1
limit	number <int32> Default: 25 Limit of items per page
search	string A string to search for in resource names
directoryId	string <uuid> UUID of the directory for filtering the results
groupId	string <uuid> UUID of the document group for filtering the results
status	string Enum: "DRAFT" "ACTIVE" "SCHEDULED" "PAUSED" "FINISHED" Filter by status
schema	string Name of the document schema (type) for filtering the results

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/schema-service/v2/documents?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&groupId=SOME_STRING_VALUE&status=SOME_STRING_VALUE&schema=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"meta": {"links": [{"url": "string",
"rel": "first"
}
],
"cursors": {"after": "string",
"before": "string"
},
"limit": 0,
"count": 0
},
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"priority": 100,
"content": {"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": "{% document exampleslug %}"
},
"slug": "basket",
"schema": "containers",
"scheduled": true,
"status": "DRAFT",
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"author": {"id": 0,
"name": "string",
"avatar": "string"
},
"directory": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
},
"group": {"id": "43c97b25-4a10-45d0-99b7-d472eea2bb24",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"nr": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}
]
}

List documents from groups

Retrieve a list of documents from a group or groups. The response includes information about relations between documents. The response is an array of objects (documents) without sorting them by group.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

Array

string <uuid>

UUID of a document group

Responses

Request samples

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"status": "DRAFT",
"priority": 100,
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"status": "DRAFT",
"priority": 100,
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"status": "DRAFT",
"priority": 100,
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"status": "DRAFT",
"priority": 100,
"children": [{ }
]
}
]
}
]
}
]
}
]

Get document by slug

Retrieve a document and its metadata. The content isn't processed.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

slug

required

string[a-z0-9]+(?:-[a-z0-9]+)*

Slug of the document

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/documents/%7Bslug%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"priority": 100,
"content": {"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": "{% document exampleslug %}"
},
"slug": "basket",
"schema": "containers",
"scheduled": true,
"status": "DRAFT",
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"author": {"id": 0,
"name": "string",
"avatar": "string"
},
"directory": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
},
"group": {"id": "43c97b25-4a10-45d0-99b7-d472eea2bb24",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"nr": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Get predecessors for document

Retrieve information about documents or screen views that refer to the requested document.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

slug

required

string[a-z0-9]+(?:-[a-z0-9]+)*

Slug of the document

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/documents/by/slug/%7Bslug%7D/predecessors 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

[{"id": "string",
"type": "document",
"name": "string",
"children": [{"id": "string",
"type": "document",
"name": "string",
"children": [{ }
]
}
]
}
]

Get predecessors for document

Retrieve information about documents or screen views that refer to the requested document.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/documents/%7BdocumentId%7D/predecessors 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

[{"id": "string",
"type": "document",
"name": "string",
"children": [{"id": "string",
"type": "document",
"name": "string",
"children": [{ }
]
}
]
}
]

Get successors for document

Retrieve information about documents referenced from the requested document.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

slug

required

string[a-z0-9]+(?:-[a-z0-9]+)*

Slug of the document

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/documents/by/slug/%7Bslug%7D/successors 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

[{"id": "string",
"type": "document",
"name": "string",
"children": [{"id": "string",
"type": "document",
"name": "string",
"children": [{ }
]
}
]
}
]

Get successors for document

Retrieve information about documents referenced from the requested document.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/documents/%7BdocumentId%7D/successors 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

[{"id": "string",
"type": "document",
"name": "string",
"children": [{"id": "string",
"type": "document",
"name": "string",
"children": [{ }
]
}
]
}
]

Get document by UUID

Retrieve a document and its metadata. The content isn't processed.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/documents/%7BdocumentId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"priority": 100,
"content": {"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": "{% document exampleslug %}"
},
"slug": "basket",
"schema": "containers",
"scheduled": true,
"status": "DRAFT",
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"author": {"id": 0,
"name": "string",
"avatar": "string"
},
"directory": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
},
"group": {"id": "43c97b25-4a10-45d0-99b7-d472eea2bb24",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"nr": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Update document

Update a document.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Request Body schema: application/json

name	string Name of the document
priority	integer <int32> <= 100 Priority of the document
	object or string Content of the document. It can contain inserts.
schema	string Schema of the document (called "Type" in the Synerise Web Application)
groupId	string <uuid> UUID of the group
	object The profiles (clients) which have access to this resource
	object Configuration of the schedule
directoryId	string <uuid> UUID of a directory. Directories can be used to organize documents and screen views for display in the Synerise Web Application. If you want to organize documents for screen view campaigns, use document groups instead. If you want to organize screen views for display, use screen view feeds instead.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"priority": 100,
"content": {"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": "{% document exampleslug %}"
},
"schema": "containers",
"groupId": "43c97b25-4a10-45d0-99b7-d472eea2bb24",
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"schedule": {"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"endType": "NEVER",
"parts": [{"startDay": 1,
"startTime": "08:18:03",
"endDay": 1,
"endTime": "44283"
}
],
"periodType": "ENTIRE",
"startDate": "2019-08-24T14:15:22Z",
"startType": "NOW",
"timezone": "Europe/Warsaw"
},
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"priority": 100,
"content": {"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": "{% document exampleslug %}"
},
"slug": "basket",
"schema": "containers",
"scheduled": true,
"status": "DRAFT",
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"author": {"id": 0,
"name": "string",
"avatar": "string"
},
"directory": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
},
"group": {"id": "43c97b25-4a10-45d0-99b7-d472eea2bb24",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"nr": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Delete document

Delete a document. This operation is irreversible.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/schema-service/v2/documents/%7BdocumentId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Copy document

Copy a document.The copy receives the DRAFT status, regardless of the status of the original document.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/v2/documents/%7BdocumentId%7D/copy 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"docId": "b394169a-e7cd-41ad-9e47-a6d4a11d664b",
"name": "string",
"status": "DRAFT",
"authorId": 0,
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18",
"scheduled": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Assign document to directory

Assign a document to a directory. A document can only belong to one directory and using this endpoint overwrites the current assignment.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId required	string <uuid> UUID of the document
directoryId required	string <uuid> UUID of the directory

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/v2/documents/%7BdocumentId%7D/directory/%7BdirectoryId%7D/attach 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"docId": "b394169a-e7cd-41ad-9e47-a6d4a11d664b",
"name": "string",
"status": "DRAFT",
"authorId": 0,
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18",
"scheduled": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Rename document directory

Update a document directory name.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

directoryId

required

string <uuid>

UUID of the directory

Request Body schema: application/json

name

required

string

New name for the directory

Responses

Request samples

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
}

Delete document directory

Delete a directory. The contents are moved into the default directory.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

directoryId

required

string <uuid>

UUID of the directory

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/schema-service/v2/documents/directory/%7BdirectoryId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
}

List document directories

Returns a list of directories.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/documents/directory 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
}
]

Add document directory

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

name

required

string

Name of the directory

Responses

Request samples

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
}

Delete document group

Delete a document group. The documents that were in this group are no longer assigned to any group.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

groupId

required

string <uuid>

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/schema-service/v2/groups/%7BgroupId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"id": "43c97b25-4a10-45d0-99b7-d472eea2bb24",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"nr": 0
}

List groups

Returns a list of groups.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/groups 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

[{"id": "43c97b25-4a10-45d0-99b7-d472eea2bb24",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"nr": 0
}
]

Add group

Create a new document group.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

name

required

string

Name of the group

Responses

Request samples

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/json

{"id": "43c97b25-4a10-45d0-99b7-d472eea2bb24",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"nr": 0
}

Finish document

Finish a document.

Finished documents are no longer displayed to recipients.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/v2/documents/%7BdocumentId%7D/status/finish 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Activate document

Activate a document. It can now be displayed to recipients.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/v2/documents/%7BdocumentId%7D/status/activate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Resume document

Resume a document that was paused.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/v2/documents/%7BdocumentId%7D/status/resume 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Pause document

Pause a document to temporarily stop displaying it to recipients

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

documentId

required

string <uuid>

UUID of the document

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/v2/documents/%7BdocumentId%7D/status/pause 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Get schema types

Retrieve a list of all schema types in the workspace. Schema types can be used to inform your application about the type of content included in the document's body.
In the Synerise Web Application, they are called "Type".

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/schemaTypes 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

["string"
]

Add schema type

Create a new schema type.
Schema types can be used to inform your application about the type of content included in the document's body.
In the Synerise Web Application, they are called "Type".

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

string (add schema type)

Schema type name.

Responses

Request samples

Content type

application/json

"string"

Response samples

Content type

application/json

"string"

Delete schema types

Delete one or more schema types. This operation is irreversible.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

Array

string

Schema ID. Ensure that the IDs are exactly the same as in the database, including escape characters.

Responses

Request samples

Content type

application/json

["string"
]

Response samples

Content type

application/json

true

Screen views

Screen view campaigns

Generate screen view from feed

When this method is called, the Synerise backend finds all screen view campaigns applicable to the JWT context and returns the screen view with the highest priority (1). Inserts are processed. If an insert can't be processed, the returned data is empty.

IMPORTANT: When the request's context is a Workspace or Synerise User JWT, only screen views with the audience set to ALL ("Everyone" in the Synerise Web Application) can be generated.

If the feed doesn't contain any screen views whose audience matches the JWT context of the request, the response is error 404.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User, Profile (formerly client), Anonymous profile (formerly client)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

feedSlug

required

string

Slug of the screen view feed

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v3/screen-views/%7BfeedSlug%7D/generate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
"priority": 99,
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"data": {"collection": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "basket",
"schema": "containers",
"content": {"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": {"uuid": "772d94f7-a604-409a-bfa9-24a64b8a5051",
"slug": "apple",
"schema": "fruit",
"content": {"color": "red"
}
}
}
}
],
"property1": null,
"property2": null
},
"path": "/v2/screen-views/f9215cb9-4a7e-410b-88cb-8bc40363cc10"
}

Generate screen view from feed

When this method is called, the Synerise backend finds all screen view campaigns applicable to the JWT context and returns the screen view with the highest priority (1). Inserts are processed. If an insert can't be processed, the returned data is empty.

IMPORTANT: When the request's context is a Workspace or Synerise User JWT, only screen views with the audience set to ALL ("Everyone" in the Synerise Web Application) can be generated.

If the feed doesn't contain any screen views whose audience matches the JWT context of the request, the response is error 404.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User, Profile (formerly client), Anonymous profile (formerly client)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

feedSlug

required

string

Slug of the screen view feed

Request Body schema: application/json

string or number

If you are generating the resource with a context that doesn't have the data for inserts in the resource (for example, a document has a {% customer param %} insert, but you're authenticated with a workspace JWT, so the customer context can't be extracted from the JWT), you can include the parameters in the request body. If an insert can't be processed, the returned content is empty.

Usage example: if the {% customer firstName %} insert is used in a document, you can pass its value by sending "customer.firstName": "Joe"

Because inserts are always encapsulated with quotation marks, inserts that return a number or a boolean value return it as a string.

Responses

Request samples

Content type

application/json

{"property1": "string",
"property2": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
"priority": 99,
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"data": {"collection": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "basket",
"schema": "containers",
"content": {"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": {"uuid": "772d94f7-a604-409a-bfa9-24a64b8a5051",
"slug": "apple",
"schema": "fruit",
"content": {"color": "red"
}
}
}
}
],
"property1": null,
"property2": null
},
"path": "/v2/screen-views/f9215cb9-4a7e-410b-88cb-8bc40363cc10"
}

Create screen view

Create a screen view.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

priority required	integer Default: 99 Priority determines which screen view to show to a customer if their profile matches the conditions of more than one screen view. `1` is the highest priority.
name	string Name of the screen view
directoryId required	string <uuid> UUID of a directory. Directories can be used to organize documents and screen views for display in the Synerise Web Application. If you want to organize documents for screen view campaigns, use document groups instead. If you want to organize screen views for display, use screen view feeds instead.
required	object (With document groups) Content of the screen view
required	object The profiles (clients) which have access to this resource
	object Configuration of the schedule
feedId required	string <uuid> UUID of the feed where this screen view is assigned.

Responses

Request samples

Payload

Content type

application/json

{"priority": 99,
"name": "string",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18",
"content": {"json": {"property1": null,
"property2": null
},
"documents": ["string"
],
"groups": ["43c97b25-4a10-45d0-99b7-d472eea2bb24"
],
"groupsOrder": false
},
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"schedule": {"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"endType": "NEVER",
"parts": [{"startDay": 1,
"startTime": "08:18:03",
"endDay": 1,
"endTime": "44283"
}
],
"periodType": "ENTIRE",
"startDate": "2019-08-24T14:15:22Z",
"startType": "NOW",
"timezone": "Europe/Warsaw"
},
"feedId": "30c3a808-1315-453b-94cf-0ccb129b558b"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"description": "string",
"status": "DRAFT",
"priority": 99,
"scheduled": true,
"author": {"id": 0,
"name": "string",
"avatar": "string"
},
"content": {"json": {"property1": null,
"property2": null
},
"documents": ["string"
],
"groups": ["43c97b25-4a10-45d0-99b7-d472eea2bb24"
],
"groupsOrder": false
},
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"directory": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
},
"feed": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"default": true
}
}

Initialize screen view

Create a screen view. It is created as a blank, without any conditions.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

name	string If no name is provided, defaults to "Unnamed document" or Screen View Campaign" (depending on what you are initializing).
directory	string <uuid> If no directory is provided, the default directory is used.

Responses

Request samples

Content type

application/json

{"name": "string",
"directory": "5277859d-f92c-478c-acab-7680a97fea68"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"description": "string",
"status": "DRAFT",
"priority": 99,
"scheduled": true,
"author": {"id": 0,
"name": "string",
"avatar": "string"
},
"content": {"json": {"property1": null,
"property2": null
},
"documents": ["string"
],
"groups": ["43c97b25-4a10-45d0-99b7-d472eea2bb24"
],
"groupsOrder": false
},
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"directory": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
},
"feed": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"default": true
}
}

Add content to screen view

Add content to a screen view. This overwrites any existing content.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Request Body schema: application/json

required	object JSON structure of the screen view. By default, a newly created screen view has the following `json` value: `"collection": "{% screenviewcollection %}"` The `{% screenviewcollection %}` insert is used to pick and display the documents from the documents in `documents` or `groups`. If this insert is not used, you must manually insert each document with `{% document slug%}`.
documents required	Array of strings An array of documents. If `groups` is used, this array must be empty.
groups required	Array of strings <uuid> An array of document groups, If `documents` is used, this array must be empty.
groupsOrder	boolean Default: false By default, group are ordered for display by their priority. When this field is set to `true`, they are displayed according to their order in the `groups` array instead.

Responses

Request samples

Content type

application/json

{"json": {"property1": null,
"property2": null
},
"documents": ["string"
],
"groups": ["43c97b25-4a10-45d0-99b7-d472eea2bb24"
],
"groupsOrder": false
}

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Add audience to screen view

Define the audience for a screen view.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Request Body schema: application/json

targetType required	string Enum: "SEGMENT" "QUERY" "ALL" The method of defining the audience: SEGMENT sets the audience to segmentations whose UUIDs are provided in `segments` QUERY sets the audience to an analytics query provided in `query` ALL sets the audience to all profiles in the database
segments	Array of strings An array of segmentation IDs. Used with `targetType: SEGMENT`
query	string Stringified `analysis` object for the segmentation analytics engine. Used with `targetType: QUERY`. Refer to the Analytics API Reference.

Responses

Request samples

Payload

Content type

application/json

{"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
}

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Update screen view priority

Update priority in a screen view.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Request Body schema: application/json

integer

Default: 99

Priority determines which screen view to show to a customer if their profile matches the conditions of more than one screen view. 1 is the highest priority.

Responses

Request samples

Content type

application/json

99

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Rename screen view

Update the name of a screen view. You can update the names of active screen views.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Request Body schema: application/json

string (update screenview name)

New name for the screen view

Responses

Request samples

Content type

application/json

"string"

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Preview screen view with a profile context

This endpoint can be used to preview a generated document as a Workspace or Synerise User. To generate the output as a profile (client), use one of the following methods:

POST /v3/screen-views/{feedSlug}/generate
GET /v3/screen-views/{feedSlug}/generate

When this method is called, the Synerise backend finds all screen view campaigns in the requested feed which are applicable to the profile and returns the screen view with the highest priority (1). Inserts are processed. If an insert can't be processed, the returned data is empty.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

feedSlug required	string Slug of the screen view feed
identifierType required	string Enum: "id" "uuid" "email" "custom_identify" Type of the profile identifier. The value is sent in `identifierValue` in the request body.

Request Body schema: application/json

identifierValue required	string Value of the selected identifier. Note that IDs must also be sent as strings.
	object Additional parameters

Responses

Request samples

Content type

application/json

{"identifierValue": "string",
"params": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
"priority": 99,
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"data": {"collection": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "basket",
"schema": "containers",
"content": {"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": {"uuid": "772d94f7-a604-409a-bfa9-24a64b8a5051",
"slug": "apple",
"schema": "fruit",
"content": {"color": "red"
}
}
}
}
],
"property1": null,
"property2": null
},
"path": "/v2/screen-views/f9215cb9-4a7e-410b-88cb-8bc40363cc10"
}

List screen view feeds

Returns a list of screen view feeds.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/screen-views/feeds 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"default": true
}
]

Create screen view feed

Create a new screen view feed.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

slug required	string Unique slug of the screen view feed
name required	string Name of the screen view feed

Responses

Request samples

Content type

application/json

{"slug": "string",
"name": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"default": true
}

List screen views

Returns a paginated list of screen views.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

query Parameters

page	number <int32> >= 1 Default: 1
limit	number <int32> Default: 25 Limit of items per page
search	string A string to search for in resource names
directoryId	string <uuid> UUID of the directory for filtering the results
status	string Enum: "DRAFT" "ACTIVE" "SCHEDULED" "PAUSED" "FINISHED" Filter by status
feedId	string <uuid> UUID of the screen view feed for filtering the results

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/schema-service/v2/screen-views?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&status=SOME_STRING_VALUE&feedId=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"meta": {"links": [{"url": "string",
"rel": "first"
}
],
"cursors": {"after": "string",
"before": "string"
},
"limit": 0,
"count": 0
},
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"description": "string",
"status": "DRAFT",
"priority": 99,
"scheduled": true,
"author": {"id": 0,
"name": "string",
"avatar": "string"
},
"content": {"json": {"property1": null,
"property2": null
},
"documents": ["string"
],
"groups": ["43c97b25-4a10-45d0-99b7-d472eea2bb24"
],
"groupsOrder": false
},
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"directory": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
},
"feed": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"default": true
}
}
]
}

Get screen view

Retrieve the details of a screen view.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/screen-views/%7BscreenViewId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"description": "string",
"status": "DRAFT",
"priority": 99,
"scheduled": true,
"author": {"id": 0,
"name": "string",
"avatar": "string"
},
"content": {"json": {"property1": null,
"property2": null
},
"documents": ["string"
],
"groups": ["43c97b25-4a10-45d0-99b7-d472eea2bb24"
],
"groupsOrder": false
},
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"directory": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
},
"feed": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"default": true
}
}

Delete screen view

Delete a screen view.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/schema-service/v2/screen-views/%7BscreenViewId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Copy screen view

Copy a screen view. The copy receives the DRAFT status, regardless of the status of the original screen view.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/v2/screen-views/%7BscreenViewId%7D/copy 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"status": "DRAFT",
"hash": "bb6639b2-a98e-49d9-804f-ed6c0e2a0d2f:2019-12-05T08:22:10.094",
"parentVersion": "string",
"authorId": "string",
"businessProfileId": 0,
"priority": 99,
"name": "string",
"description": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Get predecessors for screen view

Retrieve information about documents or screen views that refer to the requested screen view.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/screen-views/%7BscreenViewId%7D/predecessors 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

[{"id": "string",
"type": "document",
"name": "string",
"children": [{"id": "string",
"type": "document",
"name": "string",
"children": [{ }
]
}
]
}
]

Get successors for screen view

Retrieve information about documents referenced from the requested screen view.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/screen-views/%7BscreenViewId%7D/successors 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

[{"id": "string",
"type": "document",
"name": "string",
"children": [{"id": "string",
"type": "document",
"name": "string",
"children": [{ }
]
}
]
}
]

List screen view directories

Returns a list of screen view directories.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/screen-views/directory 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
}
]

Add screen view directory

Create a directory for screen views.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

name

required

string

Name of the directory

Responses

Request samples

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
}

Rename screen view directory

Update the name of a screen view directory.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

directoryId

required

string <uuid>

UUID of the directory

Request Body schema: application/json

name

required

string

Responses

Request samples

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
}

Delete screen view directory

Delete a screen view directory. The contents are moved into the default directory.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

directoryId

required

string <uuid>

UUID of the directory

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/schema-service/v2/screen-views/directory/%7BdirectoryId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
}

Assign screen view to directory

Assign a screen view to a directory. A screen view can only belong to one directory and using this endpoint overwrites the current assignment.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId required	string <uuid> UUID of the screen view
directoryId required	string <uuid> UUID of the directory

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/v2/screen-views/%7BscreenViewId%7D/directory/%7BdirectoryId%7D/attach 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"docId": "b394169a-e7cd-41ad-9e47-a6d4a11d664b",
"name": "string",
"status": "DRAFT",
"authorId": 0,
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18",
"scheduled": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Assign screen view to feed

Assign a screen view to a feed.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Request Body schema: application/json

string <uuid>

UUID of the feed to which you want to assign the screen view

Responses

Request samples

Content type

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Rename screen view feed

Update the name of a screen view feed.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

feedId

required

string <uuid>

UUID of a screen view feed

Request Body schema: application/json

name

required

string

New name of the feed

Responses

Request samples

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
}

Delete screen view feed

Delete a screen view feed. The screen views currently in this feed are moved to the default feed.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

feedId

required

string <uuid>

UUID of a screen view feed

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/schema-service/v2/screen-views/feeds/%7BfeedId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"default": true
}

Schedule object

Add a schedule to a document or screen view.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

externalId	string <uuid> UUID of the screen view or document that the schedule applies to
type	string Enum: "SCREENVIEW" "DOCUMENT" Type of the scheduled object
	object Configuration of the schedule

Responses

Request samples

Content type

application/json

{"externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
"type": "SCREENVIEW",
"schedule": {"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"endType": "NEVER",
"parts": [{"startDay": 1,
"startTime": "08:18:03",
"endDay": 1,
"endTime": "44283"
}
],
"periodType": "ENTIRE",
"startDate": "2019-08-24T14:15:22Z",
"startType": "NOW",
"timezone": "Europe/Warsaw"
}
}

Response samples

Content type

application/json

{"active": true,
"externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
"type": "SCREENVIEW",
"finished": true,
"schedule": {"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"endType": "NEVER",
"parts": [{"startDay": 1,
"startTime": "08:18:03",
"endDay": 1,
"endTime": "44283"
}
],
"periodType": "ENTIRE",
"startDate": "2019-08-24T14:15:22Z",
"startType": "NOW",
"timezone": "Europe/Warsaw"
}
}

Get schedule the schedule of an object

Get schedule object.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

objectId required	string <uuid> Screen view or document ID
objectType required	string Enum: "SCREENVIEW" "DOCUMENT" Object type

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/scheduler/entry/%7BobjectType%7D/%7BobjectId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"active": true,
"externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
"type": "SCREENVIEW",
"finished": true,
"schedule": {"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"endType": "NEVER",
"parts": [{"startDay": 1,
"startTime": "08:18:03",
"endDay": 1,
"endTime": "44283"
}
],
"periodType": "ENTIRE",
"startDate": "2019-08-24T14:15:22Z",
"startType": "NOW",
"timezone": "Europe/Warsaw"
}
}

Finish screen view

Finish a screen view. A finished document is no longer displayed.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/v2/screen-views/%7BscreenViewId%7D/status/finish 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Resume screen view

Resume a screen view that was paused.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/v2/screen-views/%7BscreenViewId%7D/status/resume 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Activate screen view

Activate a screen view. It can be displayed to customers.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/v2/screen-views/%7BscreenViewId%7D/status/activate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Pause screen view

Pause a screen view. Until resumed, it can't be displayed to customers.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/v2/screen-views/%7BscreenViewId%7D/status/pause 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Schema Builder

Flexible, re-usable data templates

Get all schemas

Retrieve a paginated list of schemas from the current Workspace.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

query Parameters

limit required	number Number of entries per page
page required	number Selected page. The first page has the index `1`.
name	string Searches for a given string in schema names. The search is not case-sensitive.

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/boxes-v2/schemas?limit=SOME_NUMBER_VALUE&page=SOME_NUMBER_VALUE&name=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"data": [{"businessProfileId": 48,
"primaryKey": {"type": "auto_pk"
},
"schemaName": "firstSchema",
"schemaId": "86403a7d-1120-491a-a789-3d328d91193d",
"createdAt": "2020-07-07T09:03:13.390101Z",
"createdBy": 1234,
"modifiedAt": "2020-07-07T09:03:13.390101Z",
"modifiedBy": 1234,
"deletedAt": "2020-07-07T09:03:13.390101Z",
"deletedBy": 1234,
"fields": {"property1": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
},
"property2": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
}
},
"layout": [{"type": "SINGLE",
"fieldName": "string"
}
],
"relations": {"property1": {"type": "one",
"schemaId": "0790bd7c-8c2b-4e31-b01a-eee434331800",
"constraints": [{"type": "equal",
"schemaFieldName": "string",
"relatedSchemaFieldName": "string"
}
]
},
"property2": {"type": "one",
"schemaId": "0790bd7c-8c2b-4e31-b01a-eee434331800",
"constraints": [{"type": "equal",
"schemaFieldName": "string",
"relatedSchemaFieldName": "string"
}
]
}
},
"tags": ["string"
],
"permissionStatus": "private"
}
],
"pagination": {"currentPageNumber": 0,
"pageSize": 0,
"sorted": true,
"totalElements": 0,
"totalPages": 0
}
}

Create schema

Create a new schema.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

Request Body schema: application/json

Structure of the schema

schemaName required	string Name of the schema
	any
required	object The fields define the data that can be entered into a record.
required	Array of Input field (object) or Columns layout (object) or Table layout (object) (Layout) [ items ] The graphical layout of the schema. The layouts are displayed according to their order in the array.
tags	Array of strings Tags assigned to the schema

Responses

Request samples

Content type

application/json

{"schemaName": "firstSchema",
"primaryKey": {"type": "auto_pk"
},
"fields": {"property1": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
},
"property2": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
}
},
"layout": [{"type": "SINGLE",
"fieldName": "string"
}
],
"tags": ["string"
]
}

Response samples

200

Content type

application/json

{"businessProfileId": 48,
"primaryKey": {"type": "auto_pk"
},
"schemaName": "firstSchema",
"schemaId": "86403a7d-1120-491a-a789-3d328d91193d",
"createdAt": "2020-07-07T09:03:13.390101Z",
"createdBy": 1234,
"modifiedAt": "2020-07-07T09:03:13.390101Z",
"modifiedBy": 1234,
"deletedAt": "2020-07-07T09:03:13.390101Z",
"deletedBy": 1234,
"fields": {"property1": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
},
"property2": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
}
},
"layout": [{"type": "SINGLE",
"fieldName": "string"
}
],
"relations": {"property1": {"type": "one",
"schemaId": "0790bd7c-8c2b-4e31-b01a-eee434331800",
"constraints": [{"type": "equal",
"schemaFieldName": "string",
"relatedSchemaFieldName": "string"
}
]
},
"property2": {"type": "one",
"schemaId": "0790bd7c-8c2b-4e31-b01a-eee434331800",
"constraints": [{"type": "equal",
"schemaFieldName": "string",
"relatedSchemaFieldName": "string"
}
]
}
},
"tags": ["string"
],
"permissionStatus": "private"
}

Get schema

Retrieve the details of a single schema.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

path Parameters

schemaId

required

string

UUID of the schema

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/boxes-v2/schemas/%7BschemaId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"businessProfileId": 48,
"primaryKey": {"type": "auto_pk"
},
"schemaName": "firstSchema",
"schemaId": "86403a7d-1120-491a-a789-3d328d91193d",
"createdAt": "2020-07-07T09:03:13.390101Z",
"createdBy": 1234,
"modifiedAt": "2020-07-07T09:03:13.390101Z",
"modifiedBy": 1234,
"deletedAt": "2020-07-07T09:03:13.390101Z",
"deletedBy": 1234,
"fields": {"property1": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
},
"property2": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
}
},
"layout": [{"type": "SINGLE",
"fieldName": "string"
}
],
"relations": {"property1": {"type": "one",
"schemaId": "0790bd7c-8c2b-4e31-b01a-eee434331800",
"constraints": [{"type": "equal",
"schemaFieldName": "string",
"relatedSchemaFieldName": "string"
}
]
},
"property2": {"type": "one",
"schemaId": "0790bd7c-8c2b-4e31-b01a-eee434331800",
"constraints": [{"type": "equal",
"schemaFieldName": "string",
"relatedSchemaFieldName": "string"
}
]
}
},
"tags": ["string"
],
"permissionStatus": "private"
}

Update schema

Update an existing schema.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_SCHEMA_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

path Parameters

schemaId

required

string

UUID of the schema

Request Body schema: application/json

Structure of the schema

schemaName required	string Name of the schema
	any
required	object The fields define the data that can be entered into a record.
required	Array of Input field (object) or Columns layout (object) or Table layout (object) (Layout) [ items ] The graphical layout of the schema. The layouts are displayed according to their order in the array.
tags	Array of strings Tags assigned to the schema

Responses

Request samples

Content type

application/json

{"schemaName": "firstSchema",
"primaryKey": {"type": "auto_pk"
},
"fields": {"property1": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
},
"property2": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
}
},
"layout": [{"type": "SINGLE",
"fieldName": "string"
}
],
"tags": ["string"
]
}

Response samples

200

Content type

application/json

{"businessProfileId": 48,
"primaryKey": {"type": "auto_pk"
},
"schemaName": "firstSchema",
"schemaId": "86403a7d-1120-491a-a789-3d328d91193d",
"createdAt": "2020-07-07T09:03:13.390101Z",
"createdBy": 1234,
"modifiedAt": "2020-07-07T09:03:13.390101Z",
"modifiedBy": 1234,
"deletedAt": "2020-07-07T09:03:13.390101Z",
"deletedBy": 1234,
"fields": {"property1": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
},
"property2": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
}
},
"layout": [{"type": "SINGLE",
"fieldName": "string"
}
],
"relations": {"property1": {"type": "one",
"schemaId": "0790bd7c-8c2b-4e31-b01a-eee434331800",
"constraints": [{"type": "equal",
"schemaFieldName": "string",
"relatedSchemaFieldName": "string"
}
]
},
"property2": {"type": "one",
"schemaId": "0790bd7c-8c2b-4e31-b01a-eee434331800",
"constraints": [{"type": "equal",
"schemaFieldName": "string",
"relatedSchemaFieldName": "string"
}
]
}
},
"tags": ["string"
],
"permissionStatus": "private"
}

Delete schema

Delete a schema. This operation is irreversible.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

path Parameters

schemaId

required

string

UUID of the schema

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/boxes-v2/schemas/%7BschemaId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Get all schema projections

Retrieve a paginated list of schema projections (simplified data of schemas) from the current Workspace.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

query Parameters

limit required	number Number of entries per page
page required	number Selected page. The first page has the index `1`.
name	string Searches for a given string in schema names. The search is not case-sensitive.

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/boxes-v2/schemas/projections?limit=SOME_NUMBER_VALUE&page=SOME_NUMBER_VALUE&name=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"data": [{"schemaId": "4da878bc-ed5d-4d32-b31c-b6f7cc68936f",
"schemaName": "schema1"
}
],
"pagination": {"currentPageNumber": 0,
"pageSize": 0,
"sorted": true,
"totalElements": 0,
"totalPages": 0
}
}

Get all predefined schemas

Retrieve a paginated list of predefined schemas.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_PREDEFINED_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

query Parameters

limit required	number Number of entries per page
page required	number Selected page. The first page has the index `1`.

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/boxes-v2/predefined-schemas?limit=SOME_NUMBER_VALUE&page=SOME_NUMBER_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"data": [{"businessProfileId": 48,
"primaryKey": {"type": "auto_pk"
},
"schemaName": "firstSchema",
"schemaId": "86403a7d-1120-491a-a789-3d328d91193d",
"createdAt": "2020-07-07T09:03:13.390101Z",
"createdBy": 1234,
"modifiedAt": "2020-07-07T09:03:13.390101Z",
"modifiedBy": 1234,
"deletedAt": "2020-07-07T09:03:13.390101Z",
"deletedBy": 1234,
"fields": {"property1": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
},
"property2": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
}
},
"layout": [{"type": "SINGLE",
"fieldName": "string"
}
],
"relations": {"property1": {"type": "one",
"schemaId": "0790bd7c-8c2b-4e31-b01a-eee434331800",
"constraints": [{"type": "equal",
"schemaFieldName": "string",
"relatedSchemaFieldName": "string"
}
]
},
"property2": {"type": "one",
"schemaId": "0790bd7c-8c2b-4e31-b01a-eee434331800",
"constraints": [{"type": "equal",
"schemaFieldName": "string",
"relatedSchemaFieldName": "string"
}
]
}
},
"tags": ["string"
],
"permissionStatus": "private"
}
],
"pagination": {"currentPageNumber": 0,
"pageSize": 0,
"sorted": true,
"totalElements": 0,
"totalPages": 0
}
}

Get predefined schema

Retrieve the details of a single predefined schema.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_PREDEFINED_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

path Parameters

schemaId

required

string

UUID of the schema

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/boxes-v2/predefined-schemas/%7BschemaId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"businessProfileId": 48,
"primaryKey": {"type": "auto_pk"
},
"schemaName": "firstSchema",
"schemaId": "86403a7d-1120-491a-a789-3d328d91193d",
"createdAt": "2020-07-07T09:03:13.390101Z",
"createdBy": 1234,
"modifiedAt": "2020-07-07T09:03:13.390101Z",
"modifiedBy": 1234,
"deletedAt": "2020-07-07T09:03:13.390101Z",
"deletedBy": 1234,
"fields": {"property1": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
},
"property2": {"type": "TEXT",
"design": {"label": "string",
"hideLabel": true,
"placeholder": "string",
"description": "string",
"tooltip": "string",
"tabIndex": 0,
"initialFocus": true
},
"validation": {"required": true,
"unique": true,
"minimumLength": 0,
"maximumLength": 0,
"regexPattern": "string",
"errorMessage": "string"
},
"layout": {"marginTop": "15px",
"marginRight": "1cm",
"marginBottom": "12pt",
"marginLeft": "1.0em"
}
}
},
"layout": [{"type": "SINGLE",
"fieldName": "string"
}
],
"relations": {"property1": {"type": "one",
"schemaId": "0790bd7c-8c2b-4e31-b01a-eee434331800",
"constraints": [{"type": "equal",
"schemaFieldName": "string",
"relatedSchemaFieldName": "string"
}
]
},
"property2": {"type": "one",
"schemaId": "0790bd7c-8c2b-4e31-b01a-eee434331800",
"constraints": [{"type": "equal",
"schemaFieldName": "string",
"relatedSchemaFieldName": "string"
}
]
}
},
"tags": ["string"
],
"permissionStatus": "private"
}

Get all records

Retrieve all records from the schema.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_RECORD_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

path Parameters

schemaId

required

string

UUID of the schema

query Parameters

limit required	number Number of entries per page
page required	number Selected page. The first page has the index `1`.

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/boxes-v2/records/%7BschemaId%7D?limit=SOME_NUMBER_VALUE&page=SOME_NUMBER_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"data": [{"schemaId": "10c681d9-5afc-4ea1-ac97-dd1d22c7b045",
"recordId": "10c681d9-5afc-4ea1-ac97-dd1d22c7b045",
"businessProfileId": 48,
"createdAt": "2020-07-07T09:03:13.390101Z",
"createdBy": 1234,
"modifiedAt": "2020-07-07T09:03:13.390101Z",
"modifiedBy": 1234,
"deletedAt": "2020-07-07T09:03:13.390101Z",
"deletedBy": 1234,
"fields": {"property1": {"amount": 112.25,
"currency": "USD"
},
"property2": {"amount": 112.25,
"currency": "USD"
}
},
"relations": {"property1": {"type": "one",
"recordId": "0790bd7c-8c2b-4e31-b01a-eee434331800"
},
"property2": {"type": "one",
"recordId": "0790bd7c-8c2b-4e31-b01a-eee434331800"
}
},
"permissionStatus": "private"
}
],
"pagination": {"currentPageNumber": 0,
"pageSize": 0,
"sorted": true,
"totalElements": 0,
"totalPages": 0
}
}

Create record

Create a new record. A record creates a database entry according to a schema.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_RECORD_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

path Parameters

schemaId

required

string

UUID of the schema

Request Body schema: application/json

The record to create

required

object

Fields and their values. Each field is an array of value objects (even if the field type requires only a single value).

Responses

Request samples

Content type

application/json

{"fields": {"property1": {"amount": 112.25,
"currency": "USD"
},
"property2": {"amount": 112.25,
"currency": "USD"
}
}
}

Response samples

200

Content type

application/json

{"schemaId": "10c681d9-5afc-4ea1-ac97-dd1d22c7b045",
"recordId": "10c681d9-5afc-4ea1-ac97-dd1d22c7b045",
"businessProfileId": 48,
"createdAt": "2020-07-07T09:03:13.390101Z",
"createdBy": 1234,
"modifiedAt": "2020-07-07T09:03:13.390101Z",
"modifiedBy": 1234,
"deletedAt": "2020-07-07T09:03:13.390101Z",
"deletedBy": 1234,
"fields": {"property1": {"amount": 112.25,
"currency": "USD"
},
"property2": {"amount": 112.25,
"currency": "USD"
}
},
"relations": {"property1": {"type": "one",
"recordId": "0790bd7c-8c2b-4e31-b01a-eee434331800"
},
"property2": {"type": "one",
"recordId": "0790bd7c-8c2b-4e31-b01a-eee434331800"
}
},
"permissionStatus": "private"
}

Get record

Retrieve the details of a single record.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_RECORD_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

path Parameters

schemaId required	string UUID of the schema
recordId required	string <uuid> UUID of the record

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/boxes-v2/records/%7BschemaId%7D/%7BrecordId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"schemaId": "10c681d9-5afc-4ea1-ac97-dd1d22c7b045",
"recordId": "10c681d9-5afc-4ea1-ac97-dd1d22c7b045",
"businessProfileId": 48,
"createdAt": "2020-07-07T09:03:13.390101Z",
"createdBy": 1234,
"modifiedAt": "2020-07-07T09:03:13.390101Z",
"modifiedBy": 1234,
"deletedAt": "2020-07-07T09:03:13.390101Z",
"deletedBy": 1234,
"fields": {"property1": {"amount": 112.25,
"currency": "USD"
},
"property2": {"amount": 112.25,
"currency": "USD"
}
},
"relations": {"property1": {"type": "one",
"recordId": "0790bd7c-8c2b-4e31-b01a-eee434331800"
},
"property2": {"type": "one",
"recordId": "0790bd7c-8c2b-4e31-b01a-eee434331800"
}
},
"permissionStatus": "private"
}

Update record

Update a record.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_RECORD_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

path Parameters

schemaId required	string UUID of the schema
recordId required	string <uuid> UUID of the record

Request Body schema: application/json

Record to update

required

object

Fields and their values. Each field is an array of value objects (even if the field type requires only a single value).

Responses

Request samples

Content type

application/json

{"fields": {"property1": {"amount": 112.25,
"currency": "USD"
},
"property2": {"amount": 112.25,
"currency": "USD"
}
}
}

Response samples

200

Content type

application/json

{"schemaId": "10c681d9-5afc-4ea1-ac97-dd1d22c7b045",
"recordId": "10c681d9-5afc-4ea1-ac97-dd1d22c7b045",
"businessProfileId": 48,
"createdAt": "2020-07-07T09:03:13.390101Z",
"createdBy": 1234,
"modifiedAt": "2020-07-07T09:03:13.390101Z",
"modifiedBy": 1234,
"deletedAt": "2020-07-07T09:03:13.390101Z",
"deletedBy": 1234,
"fields": {"property1": {"amount": 112.25,
"currency": "USD"
},
"property2": {"amount": 112.25,
"currency": "USD"
}
},
"relations": {"property1": {"type": "one",
"recordId": "0790bd7c-8c2b-4e31-b01a-eee434331800"
},
"property2": {"type": "one",
"recordId": "0790bd7c-8c2b-4e31-b01a-eee434331800"
}
},
"permissionStatus": "private"
}

Delete record

Delete a record. This operation is irreversible.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_RECORD_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

path Parameters

schemaId required	string UUID of the schema
recordId required	string <uuid> UUID of the record

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/boxes-v2/records/%7BschemaId%7D/%7BrecordId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Relative update of record

Relative update allows you to easily change the value in a record without updating the entire record. Currently, only numeric values can be changed.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_RECORD_RELATIVE_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

path Parameters

schemaId required	string UUID of the schema
recordId required	string <uuid> UUID of the record

Request Body schema: application/json

Record to be updated

required

object

Responses

Request samples

Content type

application/json

{"actions": {"property1": {"changeBy": 0
},
"property2": {"changeBy": 0
}
}
}

Response samples

200

Content type

application/json

{"schemaId": "10c681d9-5afc-4ea1-ac97-dd1d22c7b045",
"recordId": "10c681d9-5afc-4ea1-ac97-dd1d22c7b045",
"businessProfileId": 48,
"createdAt": "2020-07-07T09:03:13.390101Z",
"createdBy": 1234,
"modifiedAt": "2020-07-07T09:03:13.390101Z",
"modifiedBy": 1234,
"deletedAt": "2020-07-07T09:03:13.390101Z",
"deletedBy": 1234,
"fields": {"property1": {"amount": 112.25,
"currency": "USD"
},
"property2": {"amount": 112.25,
"currency": "USD"
}
},
"relations": {"property1": {"type": "one",
"recordId": "0790bd7c-8c2b-4e31-b01a-eee434331800"
},
"property2": {"type": "one",
"recordId": "0790bd7c-8c2b-4e31-b01a-eee434331800"
}
},
"permissionStatus": "private"
}

Get documentation list

Get a list of paths to schemas documentations.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_DOCUMENTATION_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

query Parameters

limit required	number Number of entries per page
page required	number Selected page. The first page has the index `1`.

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/boxes-v2/documentation?limit=SOME_NUMBER_VALUE&page=SOME_NUMBER_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"data": ["string"
],
"pagination": {"currentPageNumber": 0,
"pageSize": 0,
"sorted": true,
"totalElements": 0,
"totalPages": 0
}
}

Get schema documentation

Retrieve an OpenAPIv3 file with documentation for a single schema.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: BOXES_DOCUMENTATION_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_SCHEMA_BUILDER

Authorizations:

JWT

path Parameters

schemaId

required

string

UUID of the schema

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/boxes-v2/documentation/%7BschemaId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Catalogs

Store items in catalogs

Get all items as CSV file

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

query Parameters

delimiter

string

The delimiter to use in csv. You can use ; or ,. Default: ,

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/csv?delimiter=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

401
403

Content type

application/json

{"status": 0,
"error": "string",
"message": "string",
"timestamp": "string"
}

Add items from CSV

Upload items to a catalog from a CSV file

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

Request Body schema: multipart/form-data

itemKey required	string The name of the CSV column that contains unique identifiers
file required	string <binary> CSV file

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/upload 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'content-type: multipart/form-data'

Response samples

200
401
403

Content type

application/json

true

Get catalogs

Retrieve all catalogs from the Workspace. You can filter and sort the results.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

query Parameters

searchBy	string A search string. You can search the catalogs by their name or the first or last name of the author.
orderBy	string Enum: "id" "author" "lastModified" "creationDate" The parameter to order the results by. Order is always ascending.
offset	integer The offset for the search. For example, if your `limit` is 10 and you want to retrieve the third page of items, set the offset to 20. Items with indexes 20 to 29 are returned (the first item on the first page has the index 0).
limit	integer The maximum number of items to include in the response. `offset` must be defined.

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/catalogs/bags?searchBy=SOME_STRING_VALUE&orderBy=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

{"data": [{"id": 0,
"name": "string",
"businessProfileId": 0,
"author": "string",
"lastModified": "2019-08-24T14:15:22Z",
"creationDate": "2019-08-24T14:15:22Z"
}
],
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Add catalog

Create a new, empty catalog.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

Request Body schema: application/json

name	string Catalog name. IMPORTANT: The catalog name shouldn't contain spaces ( ). A catalog with spaces in the name can't be referenced with Jinjava.

Responses

Request samples

Content type

application/json

{"name": "string"
}

Response samples

200
401
403

Content type

application/json

{"data": {"id": 0,
"name": "string",
"businessProfileId": 0,
"author": "string",
"lastModified": "2019-08-24T14:15:22Z",
"creationDate": "2019-08-24T14:15:22Z"
},
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Delete catalogs

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

Request Body schema: application/json

Array

string

Catalog ID

Responses

Request samples

Content type

application/json

[1199,
1200,
1201
]

Response samples

200
401
403

Content type

application/json

{"data": [{"id": 0,
"result": true
}
],
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Get catalog keys

Retrieve the list of keys from a catalog.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/keys 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

{"data": ["id",
"isbn",
"name"
],
"metaData": {"totalCount": 3,
"requestTime": "0.071 [s]"
}
}

Get catalog info

Retrieve the metadata of a catalog

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

{"data": {"id": 0,
"name": "string",
"businessProfileId": 0,
"author": "string",
"lastModified": "2019-08-24T14:15:22Z",
"creationDate": "2019-08-24T14:15:22Z"
},
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Delete catalog

Delete a single catalog. This operation is irreversible.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

{"data": true,
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Get items from catalog

Retrieve the entries from a single catalog.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

query Parameters

itemKey	string Filter by the value of the unique identifier of the item (exact match)
searchBy	string A search string. The search takes all key values into account.
offset	integer The offset for the search. For example, if your `limit` is 10 and you want to retrieve the third page of items, set the offset to 20. Items with indexes 20 to 29 are returned (the first item on the first page has the index 0).
limit	integer The maximum number of items to include in the response. `offset` must be defined.

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items?itemKey=SOME_STRING_VALUE&searchBy=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"data": [{"bag": {"id": 0,
"name": "string",
"businessProfileId": 0,
"author": "string",
"lastModified": "2019-08-24T14:15:22Z",
"creationDate": "2019-08-24T14:15:22Z"
},
"itemKey": "string",
"id": 0,
"value": "{\"Name\":\"John\",\"Surname\":\"Doe\"}",
"creationDate": "string"
}
],
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Add item

Add a single item to the catalog.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_ITEM_BATCH_CATALOG_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

Request Body schema: application/json

JSON object with any number of key/value pairs

itemKey

required

string

The value of the unique key of the item.

IMPORTANT: This value is not visible in the Synerise Portal. If you want it to be visible in the Catalogs UI, you must add it again as a parameter in the value object. If you do this and then download the catalog as CSV, the key will be included twice: in the item_key column (used by the backend to store unique keys) and in another column, as a regular parameter.

required

object

Properties of the item. Can be an empty object.

Responses

Request samples

Content type

application/json

{"itemKey": "1357",
"value": {"itemCategory": "smartphone",
"itemColor": "blue",
"itemVersion": "4"
}
}

Response samples

200
401
403

Content type

application/json

true

Batch add items

Add a number of items at once.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_ITEM_BATCH_CATALOG_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

Request Body schema: application/json

JSON object with any number of key/value pairs

Array

itemKey

required

string

The value of the unique key of the item.

IMPORTANT: This value is not visible in the Synerise Portal. If you want it to be visible in the Catalogs UI, you must add it again as a parameter in the value object. If you do this and then download the catalog as CSV, the key will be included twice: in the item_key column (used by the backend to store unique keys) and in another column, as a regular parameter.

required

object

Properties of the item. Can be an empty object.

Responses

Request samples

Content type

application/json

[{"itemKey": "1357",
"value": {"itemCategory": "smartphone",
"itemColor": "blue",
"itemVersion": "4"
}
}
]

Response samples

200
401
403

Content type

application/json

true

Update enrichment fields

Change enrichment fields for given mapping

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_MAPPING_CATALOG_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

Request Body schema: application/json

action	string
paramKey	string
enrichmentFields	Array of strings

Responses

Request samples

Content type

application/json

{"action": "string",
"paramKey": "string",
"enrichmentFields": ["string"
]
}

Response samples

200
401
403

Content type

application/json

0

Enable filtering

Enable filtering for a catalog on selected fields

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

Request Body schema: application/json

fields

Array of strings

Responses

Request samples

Content type

application/json

{"fields": ["string"
]
}

Response samples

200
401
403

Content type

application/json

0

Disable filtering

Disable filtering for a catalog on selected fields

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

Responses

Request samples

curl --request PATCH 
  --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/disable/filtering 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

0

Get single item by itemKey

Retrieve a single item from a catalog by using the item key (unique identifier of an item in the catalog, for example a product's SKU) of the entry in the Synerise database.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId required	integer ID of the catalog
itemKey required	string `itemKey` parameter of the item to retrieve

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"data": {"bag": {"id": 0,
"name": "string",
"businessProfileId": 0,
"author": "string",
"lastModified": "2019-08-24T14:15:22Z",
"creationDate": "2019-08-24T14:15:22Z"
},
"itemKey": "string",
"id": 0,
"value": "{\"Name\":\"John\",\"Surname\":\"Doe\"}",
"creationDate": "string"
},
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Delete single item by itemKey

Delete a single item by itemKey (unique identifier of an item in the catalog, for example a product's SKU).

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId required	integer ID of the catalog
itemKey required	string `itemKey` parameter of the item to delete

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

{"data": true,
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Get single item by database ID

Retrieve a single item from a catalog by using the ID of the entry in the Synerise database. If you want retrieve an item by its unique identifier in the catalog, use this endpoint.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

itemId

required

integer

ID of the item. This is the ID of the entry in the Synerise database, not the unique identifier that you're using in your catalog. The itemId is available in the id field of the catalog item when you retrieve items from a catalog:

{
    "creationDate": "2020-09-30T11:31:16.314Z",
    "id": 73753, // this is the itemId
    "itemKey": "uniqueValue",
    "lastModified": null,
    "value": "{\"exampleKey\":\"uniqueValue\",\"exampleKey2\":\"exampleValue\"}",
    "bag": {
        "author": "authorName",
        "creationDate": "2020-09-30T10:52:31.264Z",
        "id": 1053, // this is the ID of the catalog
        "lastModified": "2020-09-30T11:41:11.808Z",
        "name": "sampleCatalog"
    }
},

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

{"data": {"bag": {"id": 0,
"name": "string",
"businessProfileId": 0,
"author": "string",
"lastModified": "2019-08-24T14:15:22Z",
"creationDate": "2019-08-24T14:15:22Z"
},
"itemKey": "string",
"id": 0,
"value": "{\"Name\":\"John\",\"Surname\":\"Doe\"}",
"creationDate": "string"
},
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Update single item by database ID

Update a single item from a catalog by using the ID of the entry in the Synerise database.

When updating, send all properties of the item, even if you're not changing them. If you omit an existing property, it is removed from the item entirely.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

itemId

required

integer

ID of the item. This is the ID of the entry in the Synerise database, not the unique identifier that you're using in your catalog. The itemId is available in the id field of the catalog item when you retrieve items from a catalog:

{
    "creationDate": "2020-09-30T11:31:16.314Z",
    "id": 73753, // this is the itemId
    "itemKey": "uniqueValue",
    "lastModified": null,
    "value": "{\"exampleKey\":\"uniqueValue\",\"exampleKey2\":\"exampleValue\"}",
    "bag": {
        "author": "authorName",
        "creationDate": "2020-09-30T10:52:31.264Z",
        "id": 1053, // this is the ID of the catalog
        "lastModified": "2020-09-30T11:41:11.808Z",
        "name": "sampleCatalog"
    }
},

Request Body schema: application/json

JSON object with any number of key/value pairs

property name*

any

The properties of the catalog item

Responses

Request samples

Content type

application/json

{"property1": null,
"property2": null
}

Response samples

200
401
403

Content type

application/json

{"data": {"bag": {"id": 0,
"name": "string",
"businessProfileId": 0,
"author": "string",
"lastModified": "2019-08-24T14:15:22Z",
"creationDate": "2019-08-24T14:15:22Z"
},
"itemKey": "string",
"id": 0,
"value": "{\"Name\":\"John\",\"Surname\":\"Doe\"}",
"creationDate": "string"
},
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Delete single item by database ID

Delete a single item by ID.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

itemId

required

integer

ID of the item. This is the ID of the entry in the Synerise database, not the unique identifier that you're using in your catalog. The itemId is available in the id field of the catalog item when you retrieve items from a catalog:

{
    "creationDate": "2020-09-30T11:31:16.314Z",
    "id": 73753, // this is the itemId
    "itemKey": "uniqueValue",
    "lastModified": null,
    "value": "{\"exampleKey\":\"uniqueValue\",\"exampleKey2\":\"exampleValue\"}",
    "bag": {
        "author": "authorName",
        "creationDate": "2020-09-30T10:52:31.264Z",
        "id": 1053, // this is the ID of the catalog
        "lastModified": "2020-09-30T11:41:11.808Z",
        "name": "sampleCatalog"
    }
},

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

{"data": true,
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Get all items

Retrieve all items from all catalogs in the Workspace.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_CATALOG_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

query Parameters

offset	integer The offset for the search. For example, if your `limit` is 10 and you want to retrieve the third page of items, set the offset to 20. Items with indexes 20 to 29 are returned (the first item on the first page has the index 0).
limit	integer The maximum number of items to include in the response. `offset` must be defined.

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/catalogs/items?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

{"data": [{"bag": {"id": 0,
"name": "string",
"businessProfileId": 0,
"author": "string",
"lastModified": "2019-08-24T14:15:22Z",
"creationDate": "2019-08-24T14:15:22Z"
},
"itemKey": "string",
"id": 0,
"value": "{\"Name\":\"John\",\"Surname\":\"Doe\"}",
"creationDate": "string"
}
],
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Add mapping

Add a new mapping. Mappings can be used to enrich events with data from catalogs.

For example, you can map the product's SKU from the "product.buy" event to the column in the catalog that includes the SKU. Whenever someone purchases an item with that SKU, you can extract data from the catalog (for example, the product's brand and category) and show that additional in the event log in the Synerise GUI.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_MAPPING_CATALOG_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

catalogId

required

integer

ID of the catalog

Request Body schema: application/json

action	string The `action` field of the event
paramKey	string The parameter in the event that corresponds to the catalog column with the unique identifiers

Responses

Request samples

Content type

application/json

{"action": "transaction.charge",
"paramKey": "sku"
}

Response samples

200
401
403

Content type

application/json

{"data": {"bpActionParamKey": "string",
"bagId": 0,
"businessProfileId": 0,
"action": "transaction.charge",
"paramKey": "sku"
},
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Get all mappings

Retrieve all mappings from the Workspace.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_MAPPING_CATALOG_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/catalogs/mappings 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

{"data": [{"bpActionParamKey": "string",
"bagId": 0,
"businessProfileId": 0,
"action": "transaction.charge",
"paramKey": "sku"
}
],
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Delete mapping

Delete a single mapping.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: CATALOGS_MAPPING_CATALOG_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

path Parameters

bpActionParamKey

required

string

The unique identifier of the mapping

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/catalogs/mappings/%7BbpActionParamKey%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

{"data": true,
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Get single item by unique key

Retrieve a single item from a catalog by using the value of the unique identifier (key) in the catalog. If you want retrieve an item by its ID in the Synerise database, use this endpoint.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ITEMS_COLLECTOR_CATALOG_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_CATALOGS

Authorizations:

JWT

query Parameters

catalogName

required

string

Name of the catalog

key

required

string

Value of the unique identifier of the item in the catalog. When you retrieve an item using this endpoint, the identifier is in the itemKey field.

{
    "creationDate": "2020-09-30T11:31:16.314Z",
    "id": 73753,
    "itemKey": "uniqueValue", // this is the value of the key
    "lastModified": null,
    "value": "{\"exampleKey\":\"uniqueValue\",\"exampleKey2\":\"exampleValue\"}",
    "bag": {
        "author": "authorName",
        "creationDate": "2020-09-30T10:52:31.264Z",
        "id": 1053,
        "lastModified": "2020-09-30T11:41:11.808Z",
        "name": "sampleCatalog"
    }
},

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/catalogs/itemDetail?catalogName=SOME_STRING_VALUE&key=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

{"data": {"itemId": "string",
"property1": null,
"property2": null
},
"metaData": {"totalCount": 0,
"requestTime": "0.11 [s]"
}
}

Asset tags

Use tags with resources such as promotions

Get all directories

Gets all tag directories from the Workspace.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_DIRECTORY_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/tags-collector/directories

Response samples

200

Content type

application/json

[{"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string",
"params": {"property1": "string",
"property2": "string"
},
"type": {"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string"
}
}
]

Create directory

Creates a directory.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_DIRECTORY_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

Request Body schema: application/json

name required	string Name of the directory
	object Free-form parameters
type	string HashID of the directory type

Responses

Request samples

Content type

application/json

{"name": "string",
"params": {"property1": "string",
"property2": "string"
},
"type": "string"
}

Response samples

201

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string",
"params": {"property1": "string",
"property2": "string"
},
"type": {"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string"
}
}

Get directory types

Gets all directory types.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_DIRECTORY_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/tags-collector/directories/types

Response samples

200

Content type

application/json

[{"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string"
}
]

Create directory type

Creates a directory type.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_DIRECTORY_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

Request Body schema: application/json

name

required

string

Name of the directory type

Responses

Request samples

Content type

application/json

{"name": "string"
}

Response samples

201

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string"
}

Delete directory

Deletes a directory.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_DIRECTORY_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

path Parameters

directoryHash

required

string

Hash ID of the directory

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/tags-collector/directories/%7BdirectoryHash%7D

Update directory

Updates a directory.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_DIRECTORY_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

path Parameters

directoryHash

required

string

Hash ID of the directory

Request Body schema: application/json

name	string Name of the directory
	object Free-form parameters

Responses

Request samples

Content type

application/json

{"name": "string",
"params": {"property1": "string",
"property2": "string"
}
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string",
"params": {"property1": "string",
"property2": "string"
},
"type": {"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string"
}
}

Get tags from directory

Retrieve tags from a directory.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_DIRECTORY_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

path Parameters

directoryHash

required

string

Hash ID of the directory

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/tags-collector/directories/%7BdirectoryHash%7D/tags

Response samples

200

Content type

application/json

[{"authorId": 0,
"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"directory": {"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string",
"params": {"property1": "string",
"property2": "string"
},
"type": {"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string"
}
},
"hash": "string",
"icon": "string",
"priority": 0,
"value": "string"
}
]

Assign tags to directory

Assign tags to a directory.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_DIRECTORY_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

path Parameters

directoryHash

required

string

Hash ID of the directory

Request Body schema: application/json

Array

string

Hash ID of a tag

Responses

Request samples

Content type

application/json

["string"
]

Unassign tags from directory

Unassign tags from a directory. This does not delete the tags or the directory.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_DIRECTORY_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

path Parameters

directoryHash

required

string

Hash ID of the directory

Request Body schema: application/json

Array

string

Hash ID of a tag

Responses

Request samples

Content type

application/json

["string"
]

Update directory type

Update the type of a directory.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_DIRECTORY_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

path Parameters

directoryHash

required

string

Hash ID of the directory

Request Body schema: application/json

directoryTypeHash

string

HashID of the directory type

Responses

Request samples

Content type

application/json

{"directoryTypeHash": "string"
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string",
"params": {"property1": "string",
"property2": "string"
},
"type": {"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string"
}
}

Get tag list

Gets a paginated list of tags that can be assigned to assets, for example promotions.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_TAG_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

query Parameters

page	integer Default: 0 Page to retrieve
size	integer Default: 10 Limit of items per page

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/tags-collector/tags?page=SOME_INTEGER_VALUE&size=SOME_INTEGER_VALUE'

Response samples

200

Content type

application/json

{"data": [{"authorId": 0,
"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"directory": {"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string",
"type": {"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string"
}
},
"hash": "string",
"icon": "string",
"priority": 0,
"value": "string"
}
],
"pagination": {"limit": 10,
"page": 0,
"pages": 0,
"total": 0
}
}

Delete multiple tags

Deletes multiple tag definitions.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_TAG_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

Request Body schema: application/json

Array

string

HashID of a tag

Responses

Request samples

Content type

application/json

["string"
]

Delete tag

Deletes a tag definition.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_TAG_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

path Parameters

tagHash

required

string

HashID of a tag

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/tags-collector/tags/%7BtagHash%7D

Update tag

Updates a tag definition.

API consumers who can use this method: Synerise User, Profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: TAGS_COLLECTOR_TAG_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_TAGS

path Parameters

tagHash

required

string

HashID of a tag

Request Body schema: application/json

color	string or null Hex code of the tag color
description	string Description of the tag
directory	string or null Hash ID of the directory where the tag is assigned
icon	string or null URL of the tag's icon
priority	integer Default: 0 Tag priority. Lower values mean higher priority.
value	string Name of the tag

Responses

Request samples

Content type

application/json

{"color": "string",
"description": "string",
"directory": "string",
"icon": "string",
"priority": 0,
"value": "string"
}

Response samples

200

Content type

application/json

{"authorId": 0,
"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"directory": {"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string",
"params": {"property1": "string",
"property2": "string"
},
"type": {"createdAt": "2019-08-24T14:15:22Z",
"hash": "string",
"name": "string"
}
},
"hash": "string",
"icon": "string",
"priority": 0,
"value": "string"
}

Profile tags

Tags that can be attributed to Profiles

Create a tag

Create a new tag that can be assigned to profiles. If you try to create a tag that already exists, the response is the existing tag.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: API_TAGS_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: CLIENT_TAGS

Authorizations:

JWT

Request Body schema: application/json

name required	string Name of the tag
color	string Display color of the tag; hexadecimal value

Responses

Request samples

Content type

application/json

{"name": "nice tag",
"color": "#0768ff"
}

Response samples

200
400
401
403
415

Content type

application/json

{"businessProfileId": 100005,
"id": 645,
"name": "nice tag",
"color": "#0768ff"
}

Get all tags

Retrieve all tags that can be assigned to profiles.

This endpoint is available from version 4.1.0

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: API_TAGS_CLIENT_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: CLIENT_TAGS

Authorizations:

JWT

header Parameters

Api-Version

required

string

Value: "4.4"

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/v4/clients/tags 
  --header 'Api-Version: SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

[{"id": 645,
"name": "nice tag",
"color": "#0768ff"
}
]

Update a tag

Update a tag. This method currently only allows modifying the color field.

If the tag has been already deleted, the response is a 404 error.

Important: This method doesn't update global tags (not related to any workspace). If you try to update a global tag, the response is a 404 error.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: API_TAGS_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: CLIENT_TAGS

Authorizations:

JWT

path Parameters

tagID

required

integer

Example: 645

ID of the tag

Request Body schema: application/json

color

string

Display color of the tag; hexadecimal value

Responses

Request samples

Content type

application/json

{"color": "#0768ff"
}

Response samples

Content type

application/json

{"businessProfileId": 100005,
"id": 645,
"name": "nice tag",
"color": "#0768ff"
}

Remove a tag

Remove a tag definition from the workspace.

If the tag has been already deleted, the response is a 404 error.

Important: This method does not remove global tag (not related to any workspace). In this case, the response is a 404 error.

Note: After removing a tag definition, the tag is still cached for a while. In that time, it is still possible for a while to remove or add this tag in profiles.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: API_TAGS_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: CLIENT_TAGS

Authorizations:

JWT

path Parameters

tagID

required

integer

Example: 645

ID of the tag

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/v4/tags/%7BtagID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

400
401
403
404
415

Content type

application/json

{"error": "string",
"status": 0,
"timestamp": "string",
"path": "string",
"message": "string",
"errors": [{"path": "string",
"timestamp": "2019-08-24T14:15:22Z",
"errorCode": "string",
"status": 0,
"message": "string",
"traceId": "string"
}
]
}

Get profile tags

Retrieve a list of tags assigned to a profile.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: API_TAGS_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: CLIENT_TAGS

Authorizations:

JWT

path Parameters

clientId

required

integer <int64>

Example: 434428563

The ID of the profile

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/v4/clients/%7BclientId%7D/tags 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
401
403

Content type

application/json

[{"id": 645,
"name": "nice tag",
"color": "#0768ff"
}
]

Assign tag to profile

Assign a tag to a profile.

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: API_ASSIGN_TAGS_EXECUTE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: CLIENT_TAGS

path Parameters

clientId required	integer <int64> Example: 434428563 The ID of the profile
tagID required	integer Example: 645 ID of the tag

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/v4/clients/%7BclientId%7D/tags/%7BtagID%7D

Response samples

Content type

application/json

{"clientId": 0,
"id": 73,
"tagId": 645
}

Remove tag from profile

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: API_ASSIGN_TAGS_EXECUTE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: CLIENT_TAGS

path Parameters

clientId required	integer <int64> Example: 434428563 The ID of the profile
tagID required	integer Example: 645 ID of the tag

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/v4/clients/%7BclientId%7D/tags/%7BtagID%7D

Response samples

400
401
403
404

Content type

application/json

{"error": "string",
"status": 0,
"timestamp": "string",
"path": "string",
"message": "string",
"errors": [{"path": "string",
"timestamp": "2019-08-24T14:15:22Z",
"errorCode": "string",
"status": 0,
"message": "string",
"traceId": "string"
}
]
}

Uploader

Upload files

Add files for dynamic attachments

Add base64 encoded files to the storage for use in dynamic attachments. You can send up to 5 files in one request. An attachment.upload event is generated when you use the endpoint.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: UPLOADER_SERVICE_STORAGE_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_EXPLORER

Authorizations:

JWT

path Parameters

identifierType

required

string

Enum: "id" "uuid" "email" "custom_identify"

Type of the profile identifier. The value is sent in identifierValue in the request body.

Request Body schema: application/json

required	Array of objects[ items ] Up to 5 files can be sent at once. The order in the array is reflected in the generated `attachment.upload` event, and the files from the event can then be accessed by their index in the array.
ttlInMinutes required	number Defines the amount of time (expressed in minutes) the file or files are available. If this parameter is not sent, the default time to live of the files is 30 days.
identifierValue required	string Value of the selected identifier. Note that IDs must also be sent as strings.
required	object Custom parameters of the files.

Responses

Request samples

Content type

application/json

{"files": [{"content": "77u/dGhpcyBpcyBqdXN0IGFuIGV4YW1wbGUgZmlsZQ==",
"mimetype": "text/csv",
"filename": "myexamplefile",
"extension": "csv"
}
],
"ttlInMinutes": 0,
"identifierValue": "string",
"parameters": { }
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"clientId": 1234,
"ttlInMinutes": 0,
"params": { },
"createdAt": "2019-08-24T14:15:22Z"
}

Upload file

Upload a new file to Synerise.

IMPORTANT: Due to technical limitations, the code examples on the right don't include the form data. If you use the examples, remember to add it.

Example correct cURL request:

curl --location 'https://api.synerise.com/uploader-service/storages/default/upload' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--form 'uploads=@"/Users/currentuser/Downloads/image.png"'

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: UPLOADER_SERVICE_STORAGE_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_EXPLORER

Authorizations:

JWT

path Parameters

container

required

string

Example: default

Name of the container in which the file will be stored

Request Body schema: multipart/form-data

uploads

required

string <binary>

File to upload, binary

Responses

Request samples

Content type

multipart/form-data

form

Response samples

200

Content type

application/json

{"result": {"files": [{"author": "string",
"canEdit": true,
"canRemove": true,
"created": "string",
"filename": "string",
"id": "string",
"uuid": "string",
"isStarred": true,
"mimeType": "image/png",
"path": {"large": "string",
"origin": "string",
"thumb": "string"
},
"size": 0,
"storageId": "string",
"updated": "string",
"url": "string",
"user_id": 0
}
],
"storageId": "string"
}
}

List files from workspace

Retrieve a list of all files in the Workspace.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: UPLOADER_SERVICE_STORAGE_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_EXPLORER

Authorizations:

JWT

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/uploader-service/storage-files/list 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

[{"author": "string",
"canEdit": true,
"canRemove": true,
"created": "string",
"filename": "string",
"id": "string",
"uuid": "string",
"isStarred": true,
"mimeType": "image/png",
"path": {"large": "string",
"origin": "string",
"thumb": "string"
},
"size": 0,
"storageId": "string",
"updated": "string",
"url": "string",
"user_id": 0
}
]

Remove files

Delete one or more files.

IMPORTANT: Due to technical limitations, the code examples on the right don't include the form data. If you use the examples, remember to add it.

Example correct cURL request:

curl --location 'https://api.synerise.com/uploader-service/storage-files/delete-by-uuid' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--form 'uuids="[\"0ac106beb55c401bac8bc8244e367512\",\"03dc506041e24c3cae284fd3f6611082\"]"'

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: UPLOADER_SERVICE_STORAGE_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_EXPLORER

Authorizations:

JWT

Request Body schema: multipart/form-data

uuids

required

string

File UUIDs, without dashes (stringified JSON array)
Example:
["0ac106beb55c401bac8bc8244e367512","03dc506041e24c3cae284fd3f6611082"]

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/uploader-service/storage-files/delete-by-uuid 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'content-type: multipart/form-data'

Response samples

200

Content type

application/json

{"0ac106beb55c401bac8bc8244e367512": true,
"03dc506041e24c3cae284fd3f6611082": true
}

Add stars

Add a star to one or more files. Stars are used to mark files as favorite and make them easier to find.

IMPORTANT: Due to technical limitations, the code examples on the right don't include the form data. If you use the examples, remember to add it.

Example correct cURL request:

curl --location 'https://api.synerise.com/uploader-service/storage-files/add-star-by-uuid' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--form 'uuids="[\"0ac106beb55c401bac8bc8244e367512\",\"03dc506041e24c3cae284fd3f6611082\"]"'

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: UPLOADER_SERVICE_STORAGE_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_EXPLORER

Authorizations:

JWT

Request Body schema: multipart/form-data

uuids

required

string

File UUIDs, without dashes (stringified JSON array)
Example:
["0ac106beb55c401bac8bc8244e367512","03dc506041e24c3cae284fd3f6611082"]

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/uploader-service/storage-files/add-star-by-uuid 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'content-type: multipart/form-data'

Response samples

200

Content type

application/json

{"0ac106beb55c401bac8bc8244e367512": false,
"03dc506041e24c3cae284fd3f6611082": true
}

Remove stars

Remove stars from one or more files.

IMPORTANT: Due to technical limitations, the code examples on the right don't include the form data. If you use the examples, remember to add it.

Example correct cURL request:

curl --location 'https://api.synerise.com/uploader-service/storage-files/remove-star-by-uuid' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--form 'uuids="[\"0ac106beb55c401bac8bc8244e367512\",\"03dc506041e24c3cae284fd3f6611082\"]"'

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: UPLOADER_SERVICE_STORAGE_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_EXPLORER

Authorizations:

JWT

Request Body schema: multipart/form-data

uuids

required

string

File UUIDs, without dashes (stringified JSON array)
Example:
["0ac106beb55c401bac8bc8244e367512","03dc506041e24c3cae284fd3f6611082"]

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/uploader-service/storage-files/remove-star-by-uuid 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'content-type: multipart/form-data'

Response samples

200

Content type

application/json

{"0ac106beb55c401bac8bc8244e367512": false,
"03dc506041e24c3cae284fd3f6611082": true
}

Documents (legacy)

Deprecated endpoints for documents

Preview document Deprecated

Preview a document.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

content required	object JSON content of the document
schema	string Schema of the document (called "Type" in the Synerise Web Application)

Responses

Request samples

Content type

application/json

{"content": { },
"schema": "containers"
}

Response samples

200

Content type

application/json

{ }

Create document version Deprecated

Create a new version of a document. To modify an existing version of a document, see Update document.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

uuid

required

string <uuid>

Document UUID. The UUID is the same for all versions of a document.

Request Body schema: application/json

content	object JSON content of the document
description	string Document description. Can be an empty string.
name	string Document name
version	string Document version

Responses

Request samples

Content type

application/json

{"content": { },
"description": "string",
"name": "string",
"version": "string"
}

Get raw document Deprecated

Retrieve a single document in raw form (inserts are not processed).

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

id

required

integer

Document ID. Each version of a document has a unique ID.

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/document/%7Bid%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"author": 0,
"content": { },
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"isActive": true,
"name": "string",
"published": false,
"schema": "containers",
"slug": "basket",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"version": "string"
}

Update document Deprecated

Update an existing version of a document. This endpoint does not create a new version. To create a new version, see Create document version.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

uuid required	string <uuid> Document UUID. The UUID is the same for all versions of a document.
id required	integer Document ID. Each version of a document has a unique ID.

Request Body schema: application/json

content	object JSON content of the document
description	string Document description. Can be an empty string.
name	string Document name

Responses

Request samples

Content type

application/json

{"content": { },
"description": "string",
"name": "string"
}

Response samples

200

Content type

application/json

{"author": 0,
"content": { },
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"isActive": true,
"name": "string",
"published": false,
"schema": "containers",
"slug": "basket",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"version": "string"
}

Generate processed document (only content) Deprecated

Retrieve a generated document, without any metadata in the response. Inserts are processed.

API consumers who can use this method: Synerise User, Profile (formerly client), Anonymous profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

slug

required

string[a-z0-9]+(?:-[a-z0-9]+)*

Slug of the document

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/document/slug/%7Bslug%7D/content 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"content": { }
}

Generate processed document (only content) Deprecated

Retrieve a generated document, without any metadata in the response. Inserts are processed.

API consumers who can use this method: Synerise User, Profile (formerly client), Anonymous profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

slug

required

string

Document slug

query Parameters

version	string Document version. If not provided, defaults to the latest version.
page	integer Page of items in the document
limit	integer Limit of items per page

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/schema-service/document/slug/%7Bslug%7D/content?version=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"content": { }
}

Generate processed document (only content) Deprecated

Retrieve a generated document, without any metadata in the response. Inserts are processed.

API consumers who can use this method: Synerise User, Profile (formerly client), Anonymous profile (formerly client), Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

slug

required

string

Document slug

query Parameters

version	string Document version. If not provided, defaults to the latest version.
page	integer Page of items in the document
limit	integer Limit of items per page

Request Body schema: application/json

property name*

string

Responses

Request samples

Content type

application/json

{"property1": "string",
"property2": "string"
}

Response samples

200

Content type

application/json

{"content": { }
}

Generate certification document with specific slug. Deprecated

Retrieve a certification document. Inserts are processed.

API consumers who can use this method: Synerise User, Profile (formerly client)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

slug

required

string

Document slug

query Parameters

version	string Document version. If not provided, defaults to the latest version.
page	integer Page of items in the document
limit	integer Limit of items per page

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/schema-service/document/certification/%7Bslug%7D?version=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"content": { },
"schema": "containers",
"slug": "basket",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Generate processed document Deprecated

Retrieve a generated document. Inserts are processed.

API consumers who can use this method: Synerise User, Profile (formerly client), Anonymous profile (formerly client)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

slug

required

string

Document slug

query Parameters

version	string Document version. If not provided, defaults to the latest version.
page	integer Page of items in the document
limit	integer Limit of items per page

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/schema-service/document/slug/%7Bslug%7D?version=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"content": { },
"schema": "containers",
"slug": "basket",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Generate processed document Deprecated

Retrieve a generated document. Inserts are processed.

API consumers who can use this method: Synerise User, Profile (formerly client), Anonymous profile (formerly client)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

slug

required

string

Document slug

query Parameters

version	string Document version. If not provided, defaults to the latest version.
page	integer Page of items in the document
limit	integer Limit of items per page

Request Body schema: application/json

property name*

string

Responses

Request samples

Content type

application/json

{"property1": "string",
"property2": "string"
}

Response samples

200

Content type

application/json

{"content": { },
"schema": "containers",
"slug": "basket",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Generate documents by schema Deprecated

Generate all documents assigned to a schema. The content is processed.

API consumers who can use this method: Synerise User, Profile (formerly client), Anonymous profile (formerly client)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

schema

required

string

Schema name

query Parameters

version	string Document version. If not defined, all document versions are generated.
page	integer Page of items in the document
limit	integer Limit of items per page

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/schema-service/document/by-schema/%7Bschema%7D?version=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

[{"content": { },
"schema": "containers",
"slug": "basket",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
]

List documents Deprecated

List all documents in the workspace. You can sort and filter the results. The content is raw.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

query Parameters

search	string Search term. The following fields are searched: `name`, `description`, `version`, `slug`.
sortBy	string Enum: "slug:asc" "slug:desc" "name:asc" "name:desc" "version:asc" "version:desc" "id:asc" "id:desc" Parameter to sort by
limit	string The maximum number of items to retrieve for pagination
offset	string Offset for pagination. The first item of the first page has the offset of `0`.

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/schema-service/document?search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&limit=SOME_STRING_VALUE&offset=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

{"data": [{"author": 0,
"content": { },
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"isActive": true,
"name": "string",
"published": false,
"schema": "containers",
"slug": "basket",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"version": "string"
}
],
"total": 0,
"offset": 0,
"limit": 0
}

Create document Deprecated

Create a new document.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

slug required	string[a-z0-9]+(?:-[a-z0-9]+)* Slug of the document
schema required	string Schema of the document (called "Type" in the Synerise Web Application)
name required	string Document name
description required	string Document description. Can be an empty string.
content required	object JSON content of the document
version required	string Document version

Responses

Request samples

Content type

application/json

{"slug": "basket",
"schema": "containers",
"name": "string",
"description": "string",
"content": { },
"version": "string"
}

Response samples

200

Content type

application/json

{"author": 0,
"content": { },
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"isActive": true,
"name": "string",
"published": false,
"schema": "containers",
"slug": "basket",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"version": "string"
}

Delete documents Deprecated

You can delete one or more documents. This operation is irreversible.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

Array

string

Document UUID

Responses

Request samples

Content type

application/json

["string"
]

Response samples

200

Content type

application/json

true

Get document versions Deprecated

Retrieve all versions of a document. The content is raw.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

uuid

required

string <uuid>

Document UUID. The UUID is the same for all versions of a document.

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/document/%7Buuid%7D/versions 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

[{"author": 0,
"content": { },
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": 0,
"isActive": true,
"name": "string",
"published": false,
"schema": "containers",
"slug": "basket",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"version": "string"
}
]

Publish document Deprecated

Publish a document. You must provide a version in the request body.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_UPDATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

uuid

required

string <uuid>

Document UUID. The UUID is the same for all versions of a document.

Request Body schema: application/json

string (publish document)

Version of the document

Responses

Request samples

Content type

application/json

"string"

Response samples

200

Content type

application/json

true

Check if slug is correct Deprecated

Check if the provided slug exists.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_DOCUMENT_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

slug

required

string

Document slug

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/document/slug/%7Bslug%7D/check 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200

Content type

application/json

true

Screen views (legacy)

Deprecated endpoints for screen view campaigns

Get all screen views Deprecated

Retrieve a paginated list of all screen view campaigns in the workspace.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

query Parameters

limit required	string The maximum number of items to retrieve for pagination
page required	integer The number of the page to retrieve
status	string Enum: "DRAFT" "ACTIVE" "SCHEDULED" "PAUSED" "FINISHED" Filter the results by screen view status

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/schema-service/screenViews?limit=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"description": "string",
"status": "DRAFT",
"priority": 99,
"scheduled": true,
"author": {"id": 0,
"name": "string",
"avatar": "string"
},
"content": {"json": {"property1": null,
"property2": null
},
"documents": ["string"
],
"groups": ["43c97b25-4a10-45d0-99b7-d472eea2bb24"
],
"groupsOrder": false
},
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"directory": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
},
"feed": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"default": true
}
}
],
"pagination": {"limit": 0,
"page": 0,
"pages": 0,
"total": 0
}
}

Get screen views by keys Deprecated

Retrieve list of screen view campaigns by keys in the workspace.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

Array

string

Responses

Request samples

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"description": "string",
"status": "DRAFT",
"priority": 99,
"scheduled": true,
"author": {"id": 0,
"name": "string",
"avatar": "string"
},
"content": {"json": {"property1": null,
"property2": null
},
"documents": ["string"
],
"groups": ["43c97b25-4a10-45d0-99b7-d472eea2bb24"
],
"groupsOrder": false
},
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"directory": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
},
"feed": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"default": true
}
}
],
"pagination": {"limit": 0,
"page": 0,
"pages": 0,
"total": 0
}
}

Get screen view Deprecated

Retrieve the details of a single screen view campaign.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId required	string <uuid> UUID of the screen view
screenViewVersion required	string Version of the screen view

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/screenViews/single/%7BscreenViewId%7D/%7BscreenViewVersion%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"parentVersion": "string",
"businessProfileId": 0,
"name": "string",
"description": "string",
"status": "DRAFT",
"priority": 99,
"scheduled": true,
"author": {"id": 0,
"name": "string",
"avatar": "string"
},
"content": {"json": {"property1": null,
"property2": null
},
"documents": [{"slug": "string",
"version": "string"
}
],
"groups": ["43c97b25-4a10-45d0-99b7-d472eea2bb24"
],
"groupsOrder": false
},
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"directory": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
},
"feed": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"default": true
}
}

Get screen view versions Deprecated

Retrieve all versions of a screen view campaign.

API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_READ
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

query Parameters

limit required	string The maximum number of items to retrieve for pagination
page required	integer The number of the page to retrieve

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/schema-service/screenViews/versions/%7BscreenViewId%7D?limit=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"draft": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"status": "DRAFT",
"hash": "bb6639b2-a98e-49d9-804f-ed6c0e2a0d2f:2019-12-05T08:22:10.094",
"parentVersion": "string",
"authorId": "string",
"businessProfileId": 0,
"priority": 99,
"name": "string",
"description": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
},
"currentlyPublished": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"status": "DRAFT",
"hash": "bb6639b2-a98e-49d9-804f-ed6c0e2a0d2f:2019-12-05T08:22:10.094",
"parentVersion": "string",
"authorId": "string",
"businessProfileId": 0,
"priority": 99,
"name": "string",
"description": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
},
"previouslyPublished": {"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"status": "DRAFT",
"hash": "bb6639b2-a98e-49d9-804f-ed6c0e2a0d2f:2019-12-05T08:22:10.094",
"parentVersion": "string",
"authorId": "string",
"businessProfileId": 0,
"priority": 99,
"name": "string",
"description": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}
],
"pagination": {"limit": 0,
"page": 0,
"pages": 0,
"total": 0
}
}
}

Generate screen view Deprecated

When this method is called, the Synerise backend finds all screen view campaigns applicable to the profile and returns the screen view with the highest priority (1).

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User, Profile (formerly client), Anonymous profile (formerly client)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/screenViews/generate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{ }

Generate screen view Deprecated

When this method is called, the Synerise backend finds all screen view campaigns applicable to the profile and returns the screen view with the highest priority (1).

API consumers who can use this method: Workspace (formerly Business Profile), Synerise User, Profile (formerly client), Anonymous profile (formerly client)
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/schema-service/v2/screenViews/generate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"parentVersion": "string",
"name": "string",
"priority": 99,
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"hash": "bb6639b2-a98e-49d9-804f-ed6c0e2a0d2f:2019-12-05T08:22:10.094",
"path": "/screenView",
"data": { }
}

Initialize screen view Deprecated

Create a new screen view campaign. It is created as a blank, without any conditions.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/screenViews/createNew 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"status": "DRAFT",
"hash": "bb6639b2-a98e-49d9-804f-ed6c0e2a0d2f:2019-12-05T08:22:10.094",
"parentVersion": "string",
"authorId": "string",
"businessProfileId": 0,
"priority": 99,
"name": "string",
"description": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Copy content Deprecated

Copy content to a screen view draft from another screen view.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId required	string <uuid> UUID of the screen view
screenViewVersion required	string Version of the screen view

Request Body schema: application/json

screenViewId	string <uuid> UUID of the screen view
screenViewVersion	string Version of the screen view

Responses

Request samples

Content type

application/json

{"screenViewId": "481855c5-f86e-453f-a0fa-d34b5a2be745",
"screenViewVersion": "string"
}

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Add content Deprecated

Add content to a screen view draft.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId required	string <uuid> UUID of the screen view
screenViewVersion required	string Version of the screen view

Request Body schema: application/json

required	object JSON structure of the screen view. By default, a newly created screen view has the following `json` value: `"collection": "{% screenviewcollection %}"` The `{% screenviewcollection %}` insert is used to pick and display the documents from the documents in `documents` or `groups`. If this insert is not used, you must manually insert each document with `{% document slug%}`.
documents required	Array of strings An array of documents. If `groups` is used, this array must be empty.
groups required	Array of strings <uuid> An array of document groups, If `documents` is used, this array must be empty.
groupsOrder	boolean Default: false By default, group are ordered for display by their priority. When this field is set to `true`, they are displayed according to their order in the `groups` array instead.

Responses

Request samples

Content type

application/json

{"json": {"property1": null,
"property2": null
},
"documents": ["string"
],
"groups": ["43c97b25-4a10-45d0-99b7-d472eea2bb24"
],
"groupsOrder": false
}

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Add audience Deprecated

Define the audience for a screen view draft.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId required	string <uuid> UUID of the screen view
screenViewVersion required	string Version of the screen view

Request Body schema: application/json

targetType required	string Enum: "SEGMENT" "QUERY" "ALL" The method of defining the audience: SEGMENT sets the audience to segmentations whose UUIDs are provided in `segments` QUERY sets the audience to an analytics query provided in `query` ALL sets the audience to all profiles in the database
segments	Array of strings An array of segmentation IDs. Used with `targetType: SEGMENT`
query	string Stringified `analysis` object for the segmentation analytics engine. Used with `targetType: QUERY`. Refer to the Analytics API Reference.

Responses

Request samples

Payload

Content type

application/json

{"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
}

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Publish screen view Deprecated

Make the screen view accessible to customers.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId required	string <uuid> UUID of the screen view
screenViewVersion required	string Version of the screen view

Request Body schema: application/json

overwrite

required

boolean

Currently unused

Responses

Request samples

Content type

application/json

{"overwrite": true
}

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Copy draft from existing screen view Deprecated

Copy a duplicate of an active screen view. The duplicate is in draft status.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

screenViewId	string <uuid> UUID of the screen view
screenViewVersion	string Version of the screen view

Responses

Request samples

Content type

application/json

{"screenViewId": "481855c5-f86e-453f-a0fa-d34b5a2be745",
"screenViewVersion": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"status": "DRAFT",
"hash": "bb6639b2-a98e-49d9-804f-ed6c0e2a0d2f:2019-12-05T08:22:10.094",
"parentVersion": "string",
"authorId": "string",
"businessProfileId": 0,
"priority": 99,
"name": "string",
"description": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Create draft from existing screen view Deprecated

Create a duplicate of an active screen view. The duplicate is in draft status.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

Request Body schema: application/json

screenViewId	string <uuid> UUID of the screen view
screenViewVersion	string Version of the screen view

Responses

Request samples

Content type

application/json

{"screenViewId": "481855c5-f86e-453f-a0fa-d34b5a2be745",
"screenViewVersion": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"status": "DRAFT",
"hash": "bb6639b2-a98e-49d9-804f-ed6c0e2a0d2f:2019-12-05T08:22:10.094",
"parentVersion": "string",
"authorId": "string",
"businessProfileId": 0,
"priority": 99,
"name": "string",
"description": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}

Update screen view description Deprecated

Update the description of a screen view. You can update the descriptions of active screen views.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId required	string <uuid> UUID of the screen view
screenViewVersion required	string Version of the screen view

Request Body schema: application/json

string (update screenview description)

New description of the screen view

Responses

Request samples

Content type

application/json

"string"

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Update screen view priority Deprecated

Update the priority of a screen view. You can update the priorities of active screen views.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId required	string <uuid> UUID of the screen view
screenViewVersion required	string Version of the screen view

Request Body schema: application/json

integer (update screenview priority)

New priority of the screen view

Responses

Request samples

Content type

application/json

0

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Discard changes Deprecated

Discard the changes made in a version of a screen view.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_CREATE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId required	string <uuid> UUID of the screen view
screenViewVersion required	string Version of the screen view

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/schema-service/screenViews/discardChanges/%7BscreenViewId%7D/%7BscreenViewVersion%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"parentVersion": "string",
"businessProfileId": 0,
"name": "string",
"description": "string",
"status": "DRAFT",
"priority": 99,
"scheduled": true,
"author": {"id": 0,
"name": "string",
"avatar": "string"
},
"content": {"json": {"property1": null,
"property2": null
},
"documents": [{"slug": "string",
"version": "string"
}
],
"groups": ["43c97b25-4a10-45d0-99b7-d472eea2bb24"
],
"groupsOrder": false
},
"audience": {"targetType": "SEGMENT",
"segments": ["string"
],
"query": "{\"analysis\":{\"title\":\"Unnamed segmentation\",\"description\":\"\",\"unique\":true,\"segments\":[{\"title\":\"Segmentation A\",\"description\":\"\",\"filter\":{\"matching\":true,\"expressions\":[{\"_id\":\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\",\"name\":\"\",\"type\":\"FUNNEL\",\"matching\":true,\"funnel\":{\"_id\":\"5c759d73-49c6-409f-96a3-b569dff8f8ff\",\"title\":\"Unnamed\",\"completedWithin\":null,\"dateFilter\":{\"type\":\"RELATIVE\",\"offset\":{\"type\":\"DAYS\",\"value\":0},\"duration\":{\"type\":\"DAYS\",\"value\":30}},\"steps\":[{\"_id\":\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\",\"title\":\"\",\"action\":{\"id\":944,\"name\":\"page.visit\"},\"eventName\":\"page.visit\",\"expressions\":[]}],\"exact\":false}}]}}]}}"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"directory": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"businessProfileId": 0,
"name": "string",
"objectType": "EXPRESSION",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isDefault": true
},
"feed": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"default": true
}
}

Delete screen view Deprecated

Delete a screen view and all its versions. This operation is irreversible.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId

required

string <uuid>

UUID of the screen view

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/schema-service/screenViews/delete/%7BscreenViewId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}

Delete screen view version Deprecated

Delete a version of a screen view.

API consumer who can use this method: Synerise User
API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: SCHEMA_SERVICE_SCHEMA_DELETE
User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ASSETS_DOCS

Authorizations:

JWT

path Parameters

screenViewId required	string <uuid> UUID of the screen view
screenViewVersion required	string Version of the screen view

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/schema-service/screenViews/single/delete/%7BscreenViewId%7D/%7BscreenViewVersion%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type

application/json

{"status": "string",
"body": "string"
}