Synerise API Reference (4.4)

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.

To open Synerise's collection in Postman, click here: Run in Postman

Remember that every API call must have these headers:

Header Name Header Value
Accept application/json
Content-Type application/json
Api-Version: 4.4
Authorization (does not apply to Logs in endpoints) Bearer {JWT token}

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

Authorization

Synerise API Consumer Types

Synerise defines two different types of API consumers:

Client

This is the end user of your website or application - the one who browses pages, purchases items, and so on. The client can register and maintain their own account. They can also perform other customer actions, such as redeeming vouchers. The Client can access and modify only their own data.

Business Profile

The Business Profile is assigned to a particular company. This consumer can use methods that, for example, create client accounts, record client actions, or manage promotions.

Refresh a Client token

Retrieve a refreshed JWT Token to prolong the Client session.

You must be logged in as Client and have an active token.

Authorizations:
header Parameters
Accept
required
string
Value:"application/json"
Content-Type
required
string
Value:"application/json"
Api-Version
required
string
Value:"4.4"

Responses

200

New authorization token

401

Unauthorized

get /auth/refresh/client
https://api.synerise.com/v4/auth/refresh/client

Request samples

Copy
curl --request GET 
  --url https://api.synerise.com/auth/refresh/client 
  --header 'accept: SOME_STRING_VALUE' 
  --header 'api-version: SOME_STRING_VALUE' 
  --header 'content-type: SOME_STRING_VALUE'

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI3ZTZjYmMwMTBlZmJhMTliOTkwMTFhNWU1ZGQ4MDViMiIsImF1ZCI6IkFQSSIsInJsbSI6ImNsaWVudCIsImN0ZCI6MTUyODM1NTgzMjEzOCwiZW1sIjoia3J6eXN6dG9mLmN6ZXJlcGFrQGdtYWlsLmNvbSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo1OTQsImNsSWQiOjUyNTQ0NjU3NCwinvalidx2XwJp-QBZ94d_EEKf41KtDCE33KhP_vTAYrs-JzbnIHgKRvG6ZRwsNOL8OTnbfbUZH4XYaqBB_tZTPPKfzHutP6GEGp7PLtu2E92JbChkVyrn8VCQ5v4z2e1-zsdgbmWcQk2g9RydaydO6NYO55suT3Hz2ZRv0AYLsG8rM1biZGdREWx9OaknVVuIo2ivehBiukL7VQ6Bu8ugjep3mn-z666a-nCMh6ZuASiQ6Geq0NSWmdDQIoCa5Hg44KzMfGRlCR2uKBXeHTD0SkwJ1VJM0sHNKwSfMXKpaX8OJ5wUJpgCzDzQwKVgxgWFp4eO_sbcvxWrpI7W0lfdCy1WKirnZ6Uh3uJ06v97GQDAQqVgBZFEpS47MrGZhTNuAG4ZbfYO7yyxVO8AHQbEC-UvZ-8DC1XZjvQ6S1uNqQIlVGcthnrxg8K6vKVhNzu6ifQI0bbsCl8bGsKkXOEK1pKR3ekckcSjNeeY2LrcdXs8F2gtkm0TjXU"
}

Log in as Client

Obtain a new Client JWT Token.

header Parameters
Accept
required
string
Value:"application/json"
Content-Type
required
string
Value:"application/json"
Api-Version
required
string
Value:"4.4"
Request Body schema: application/json
apiKey
required
string

Client API key

email
required
string

Client e-mail

password
required
string

Client password

uuid
required
string

Client UUID

Responses

200

Client authorization token

401

Unauthorized

post /auth/login/client
https://api.synerise.com/v4/auth/login/client

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "apiKey": "5AEAA3D5-E147-C7EB-invalid50109A3D1",
  • "email": "testDoc@example.com",
  • "password": "testPass1!",
  • "uuid": "b3f56868-9667-4843-a8e5-0509456baa9b"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI3ZTZjYmMwMTBlZmJhMTliOTkwMTFhNWU1ZGQ4MDViMiIsImF1ZCI6IkFQSSIsInJsbSI6ImNsaWVudCIsImN0ZCI6MTUyODM1NTgzMjEzOCwiZW1sIjoia3J6eXN6dG9mLmN6ZXJlcGFrQGdtYWlsLmNvbSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo1OTQsImNsSWQiOjUyNTQ0NjU3NCwiZXhwIjoxNTI4MzU5NDMyLCJhcGsiOiI2MjIzNzZGOC00QThGLThCMjQtRDdGOS0wNzBGQTk1NkU5NjMifQ.LRGyk4jfdbnvQmXVOw_4YZBaTISjACLEqeieOiw3icjlfJEaDlB6HmrQ0apxNgwCKWruWRSUTzVaO7RB1_M45lLxda2AJ7dgegJu9kfa4hVxJSbGkVJEhtv1-C8x8OIOIyQ1Tj3ulSdq2AZbsjFtetUfiRqA-y8sg2OUiRm2OCahAbZL7otDi3VK8Jx2XwJp-QBZ94d_EEKf41KtDCE33KhP_vTAYrs-JzbnIHgKRvG6ZRwsNOL8OTnbfbUZH4XYaqBB_tZTPPKfzHutP6GEGp7PLtu2E92JbChkVyrn8VCQ5v4z2e1-zsdgbmWcQk2g9RydaydO6NYO55suT3Hz2ZRv0AYLsG8rM1biZGdREWx9OaknVVuIo2ivehBiukL7VQ6Bu8ugjep3mn-z666a-nCMh6ZuASiQ6Geq0NSWmdDQIoCa5Hg44KzMfGRlCR2uKBXeHTD0SkwJ1VJM0sHNKwSfMXKpaX8OJ5wUJpgCzDzQwKVgxgWFp4eO_sbcvxWrpI7W0lfdCy1WKirnZ6Uh3uJ06v97GQDAQqVgBZFEpS47MrGZhTNuAG4ZbfYO7yyxVO8AHQbEC-UvZ-8DC1XZjvQ6S1uNqQIlVGcthnrxg8K6vKVhNzu6ifQI0bbsCl8bGsKkXOEK1pKR3ekckcSjNeeY2LrcdXs8F2gtkm0TjXU"
}

Log in anonymously

Obtain a new JWT for an anonymous Client (without an existing Client profile). The token can be used and refreshed in the same way as tokens of registered Clients.

header Parameters
Accept
required
string
Value:"application/json"
Content-Type
required
string
Value:"application/json"
Api-Version
required
string
Value:"4.4"
Request Body schema: application/json
apiKey
required
string

Client API key (same as for Client login)

deviceId
string

Unique Android or iOS device ID

uuid
required
string

Client UUID

Responses

200

Anonymous authorization token

401

Unauthorized

post /auth/login/client/anonymous
https://api.synerise.com/v4/auth/login/client/anonymous

Request samples

Content type
application/json
Copy
Expand all Collapse all
"{\"apiKey\":\"5AEAA3D5-E147-C7EB-invalid50109A3D1\",\"deviceId\":\"000000\",\"uuid\":\"622376F8-0000-2222-D7F9-070FA956E963\"}"

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIzM2QwYjY5NWM4NjMwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.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 with Facebook

Use a Facebook token to obtain a Client JWT Token. If a Facebook account is logging on for the first time, a Client account in Synerise is created.

Authorizations:
header Parameters
Accept
required
string
Value:"application/json"
Content-Type
required
string
Value:"application/json"
Api-Version
required
string
Value:"4.4"
Request Body schema: application/json
facebookToken
required
string

Facebook authentication token

apiKey
required
string

Client API key (same as for Client login)

uuid
required
string

Client UUID

deviceId
string

Unique Android or iOS device ID

agreements
object

Marketing agreements of the Client

You can also pass the values as strings ("true";"TRUE";"True"/"false";"FALSE";"False") or integers (1 for true and 0 for false).

attributes
object

Custom attributes

tags
Array of strings

Tags can be used to group Client accounts.

Responses

200

Client authorization token

post /auth/login/client/facebook
https://api.synerise.com/v4/auth/login/client/facebook

Request samples

Content type
application/json
Copy
Expand all Collapse all
"{\"facebookToken\":\"EAAfsMmaWLW0BAOZAqSoh8ZB5y2ZAixtSrlvvq3fpWGlcrfcoWOiAwBCZBpBDlzwHFSZB58nUBjOz2UMuopO7p2Q65QU1ZAiB2XaxRzje0bBd7Tu87f6C2pcoZAP65agWAF0ElZCNyKn4iAtFd9RhppkwU9ll0AokBZBnDroZCIaxE3IHSWGtE567AUrXkZAsQEjYsZAZAcYx0ki1w7XUToy9Wps9NA0OuBdMhruB3htuiukwOFAZDZD\",\"apiKey\":\"5AEAA3D5-E147-C7EB-invalid50109A3D1\",\"uuid\":\"91b8e035-dca3-4805-8915-2cfb01d31fde\",\"deviceId\":\"deviceId\",\"agreements\":{\"email\":true,\"sms\":true,\"push\":true,\"bluetooth\":true,\"rfid\":true,\"wifi\":true},\"attributes\":{\"property1\":\"string\",\"property2\":\"string\"}}"

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI3ZTZjYmMwMTBlZmJhMTliOTkwMTFhNWU1ZGQ4MDViMiIsImF1ZCI6IkFQSSIsInJsbSI6ImNsaWVudCIsImN0ZCI6MTUyODM1NTgzMjEzOCwiZW1sIjoia3J6eXN6dG9mLmN6ZXJlcGFrQGdtYWlsLmNvbSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo1OTQsImNsSWQiOjUyNTQ0NjU3NCwinvalidx2XwJp-QBZ94d_EEKf41KtDCE33KhP_vTAYrs-JzbnIHgKRvG6ZRwsNOL8OTnbfbUZH4XYaqBB_tZTPPKfzHutP6GEGp7PLtu2E92JbChkVyrn8VCQ5v4z2e1-zsdgbmWcQk2g9RydaydO6NYO55suT3Hz2ZRv0AYLsG8rM1biZGdREWx9OaknVVuIo2ivehBiukL7VQ6Bu8ugjep3mn-z666a-nCMh6ZuASiQ6Geq0NSWmdDQIoCa5Hg44KzMfGRlCR2uKBXeHTD0SkwJ1VJM0sHNKwSfMXKpaX8OJ5wUJpgCzDzQwKVgxgWFp4eO_sbcvxWrpI7W0lfdCy1WKirnZ6Uh3uJ06v97GQDAQqVgBZFEpS47MrGZhTNuAG4ZbfYO7yyxVO8AHQbEC-UvZ-8DC1XZjvQ6S1uNqQIlVGcthnrxg8K6vKVhNzu6ifQI0bbsCl8bGsKkXOEK1pKR3ekckcSjNeeY2LrcdXs8F2gtkm0TjXU"
}

Authenticate with Facebook without registration

Use a Facebook token to obtain a Client JWT Token for a Client that is not registered in Synerise.

Authorizations:
header Parameters
Accept
required
string
Value:"application/json"
Content-Type
required
string
Value:"application/json"
Api-Version
required
string
Value:"4.4"
Request Body schema: application/json
facebookToken
required
string

Facebook Authentication Token

apiKey
required
string

Client API key (same as for Client login)

uuid
required
string

Client UUID

deviceId
string

Unique Android or iOS device ID

agreements
object

Marketing agreements of the Client

You can also pass the values as strings ("true";"TRUE";"True"/"false";"FALSE";"False") or integers (1 for true and 0 for false).

attributes
object

Custom attributes

tags
Array of strings

Tags can be used to group Client accounts.

Responses

200

Client authorization token

post /auth/login/client/facebook/no-registration
https://api.synerise.com/v4/auth/login/client/facebook/no-registration

Request samples

Content type
application/json
Copy
Expand all Collapse all
"{\"facebookToken\":\"EAAfsMmaWLW0BAOZAqSoh8ZB5y2ZAixtSrlvvq3fpWGlcrfcoWOiAwBCZBpBDlzwHFSZB58nUBjOz2UMuopO7p2Q65QU1ZAiB2XaxRzje0bBd7Tu87f6C2pcoZAP65agWAF0ElZCNyKn4iAtFd9RhppkwU9ll0AokBZBnDroZCIaxE3IHSWGtE567AUrXkZAsQEjYsZAZAcYx0ki1w7XUToy9Wps9NA0OuBdMhruB3htuiukwOFAZDZD\",\"apiKey\":\"5AEAA3D5-E147-C7EB-invalid50109A3D1\",\"uuid\":\"91b8e035-dca3-4805-8915-2cfb01d31fde\",\"deviceId\":\"deviceId\",\"agreements\":{\"email\":true,\"sms\":true,\"push\":true,\"bluetooth\":true,\"rfid\":true,\"wifi\":true},\"attributes\":{\"property1\":\"string\",\"property2\":\"string\"}}"

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI3ZTZjYmMwMTBlZmJhMTliOTkwMTFhNWU1ZGQ4MDViMiIsImF1ZCI6IkFQSSIsInJsbSI6ImNsaWVudCIsImN0ZCI6MTUyODM1NTgzMjEzOCwiZW1sIjoia3J6eXN6dG9mLmN6ZXJlcGFrQGdtYWlsLmNvbSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo1OTQsImNsSWQiOjUyNTQ0NjU3NCwinvalidx2XwJp-QBZ94d_EEKf41KtDCE33KhP_vTAYrs-JzbnIHgKRvG6ZRwsNOL8OTnbfbUZH4XYaqBB_tZTPPKfzHutP6GEGp7PLtu2E92JbChkVyrn8VCQ5v4z2e1-zsdgbmWcQk2g9RydaydO6NYO55suT3Hz2ZRv0AYLsG8rM1biZGdREWx9OaknVVuIo2ivehBiukL7VQ6Bu8ugjep3mn-z666a-nCMh6ZuASiQ6Geq0NSWmdDQIoCa5Hg44KzMfGRlCR2uKBXeHTD0SkwJ1VJM0sHNKwSfMXKpaX8OJ5wUJpgCzDzQwKVgxgWFp4eO_sbcvxWrpI7W0lfdCy1WKirnZ6Uh3uJ06v97GQDAQqVgBZFEpS47MrGZhTNuAG4ZbfYO7yyxVO8AHQbEC-UvZ-8DC1XZjvQ6S1uNqQIlVGcthnrxg8K6vKVhNzu6ifQI0bbsCl8bGsKkXOEK1pKR3ekckcSjNeeY2LrcdXs8F2gtkm0TjXU"
}

Authenticate with OAuth

Obtain a new JWT token by using OAuth authentication token.

Authorizations:
header Parameters
Accept
required
string
Value:"application/json"
Content-Type
required
string
Value:"application/json"
Api-Version
required
string
Value:"4.4"
Request Body schema: application/json
accessToken
required
string

OAuth token

apiKey
required
string

Client API key (same as for Client login)

uuid
required
string

Client UUID

deviceId
string

Unique Android or iOS device ID

agreements
object

Marketing agreements of the Client

You can also pass the values as strings ("true";"TRUE";"True"/"false";"FALSE";"False") or integers (1 for true and 0 for false).

attributes
object

Custom attributes

tags
Array of strings

Tags can be used to group Client accounts.

Responses

200

Client authorization token

post /auth/login/client/oauth
https://api.synerise.com/v4/auth/login/client/oauth

Request samples

Content type
application/json
Copy
Expand all Collapse all
"{\"accessToken\":\"EAAfsMmaWLW0BAOZAqSoh8ZB5y2ZAixtSrlvvq3fpWGlcrfcoWOiAwBCZBpBDlzwHFSZB58nUBjOz2UMuopO7p2Q65QU1ZAiB2XaxRzje0bBd7Tu87f6C2pcoZAP65agWAF0ElZCNyKn4iAtFd9RhppkwU9ll0AokBZBnDroZCIaxE3IHSWGtE567AUrXkZAsQEjYsZAZAcYx0ki1w7XUToy9Wps9NA0OuBdMhruB3htuiukwOFAZDZD\",\"apiKey\":\"5AEAA3D5-E147-C7EB-invalid50109A3D1\",\"uuid\":\"91b8e035-dca3-4805-8915-2cfb01d31fde\",\"deviceId\":\"deviceId\",\"agreements\":{\"email\":true,\"sms\":true,\"push\":true,\"bluetooth\":true,\"rfid\":true,\"wifi\":true},\"attributes\":{\"property1\":\"string\",\"property2\":\"string\"}}"

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI3ZTZjYmMwMTBlZmJhMTliOTkwMTFhNWU1ZGQ4MDViMiIsImF1ZCI6IkFQSSIsInJsbSI6ImNsaWVudCIsImN0ZCI6MTUyODM1NTgzMjEzOCwiZW1sIjoia3J6eXN6dG9mLmN6ZXJlcGFrQGdtYWlsLmNvbSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo1OTQsImNsSWQiOjUyNTQ0NjU3NCwinvalidx2XwJp-QBZ94d_EEKf41KtDCE33KhP_vTAYrs-JzbnIHgKRvG6ZRwsNOL8OTnbfbUZH4XYaqBB_tZTPPKfzHutP6GEGp7PLtu2E92JbChkVyrn8VCQ5v4z2e1-zsdgbmWcQk2g9RydaydO6NYO55suT3Hz2ZRv0AYLsG8rM1biZGdREWx9OaknVVuIo2ivehBiukL7VQ6Bu8ugjep3mn-z666a-nCMh6ZuASiQ6Geq0NSWmdDQIoCa5Hg44KzMfGRlCR2uKBXeHTD0SkwJ1VJM0sHNKwSfMXKpaX8OJ5wUJpgCzDzQwKVgxgWFp4eO_sbcvxWrpI7W0lfdCy1WKirnZ6Uh3uJ06v97GQDAQqVgBZFEpS47MrGZhTNuAG4ZbfYO7yyxVO8AHQbEC-UvZ-8DC1XZjvQ6S1uNqQIlVGcthnrxg8K6vKVhNzu6ifQI0bbsCl8bGsKkXOEK1pKR3ekckcSjNeeY2LrcdXs8F2gtkm0TjXU"
}

Client

These methods allow you to manage Client accounts.

List Clients

Retrieve a list of Clients. You can filter, sort, and paginate the results.

You must be logged in as one of the following:

  • Business Profile using an API Key with a REALM_CLIENT scope.
  • User with ROLE_CLIENT_SHOW role assigned.
Authorizations:
query Parameters
sortBy
string
Enum:"firstName" "lastName" "lastActivityDate" "email" "city" "phone"
Example:

Client attribute by which the list will be sorted

sortOrder
string
Enum:"ASC" "DESC"

Sorting order

pageIndex
integer <int32> >= 1

Number of pages to retrieve

pageSize
integer <int32> >= 1

Number of entries on a page

filters[anonymous]
boolean

When set to true, only anonymous clients are listed

filters[firstName]
string
Example:

Filter Clients by first name

filters[lastName]
string
Example:

Filter Clients by last name

filters[email]
string
Example:

Filter Clients by city

filters[phone]
string
Example:

Filter Clients by phone

header Parameters
Accept
required
string
Value:"application/json"
Content-Type
required
string
Value:"application/json"
Api-Version
required
string
Value:"4.4"

Responses

200

A list of Clients

400

Bad Request

401

Unauthorized

403

Forbidden

415

Unsupported Media Type

get /clients
https://api.synerise.com/v4/clients

Request samples

Copy
curl --request GET 
  --url 'https://api.synerise.com/v4/clients?sortBy=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&pageIndex=SOME_INTEGER_VALUE&pageSize=SOME_INTEGER_VALUE&filters%5Banonymous%5D=SOME_BOOLEAN_VALUE&filters%5BfirstName%5D=SOME_STRING_VALUE&filters%5BlastName%5D=SOME_STRING_VALUE&filters%5Bemail%5D=SOME_STRING_VALUE&filters%5Bphone%5D=SOME_STRING_VALUE' 
  --header 'accept: SOME_STRING_VALUE' 
  --header 'api-version: SOME_STRING_VALUE' 
  --header 'content-type: SOME_STRING_VALUE'

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    },
  • {
    }
]

Create a Client in CRM

Create a new client account in the Synerise application database. If you don't have some information about the client, don't insert a null-value parameter - omit the parameter entirely.

You must be logged in as one of the following:

  • Business Profile using an API Key with a REALM_CLIENT scope.
  • User with ROLE_CLIENT_CREATE role assigned.
Authorizations:
header Parameters
Accept
required
string
Value:"application/json"
Content-Type
required
string
Value:"application/json"
Api-Version
required
string
Value:"4.4"
Request Body schema: application/json
email
string

Client's e-mail address

phone
string

Client's phone number

customId
string

A custom ID for the Client

firstName
string

Client's first name

lastName
string

Client's last name

displayName
string

Currently unused

uuid
string

UUID of the Client

avatarUrl
string Nullable

URL of the Client's avatar picture

birthDate
string

Client's date of birth

company
string

Client's company

city
string

Client's city of residence

address
string

Client's street address

zipCode
string

Client's zip code

province
string

Client's province of residence

countryCode
string

Code of Client's country of residence

sex
string
Enum:"FEMALE" "MALE" "UNDEFINED"

Client's sex

agreements
object

Marketing agreements of the Client.

You can also pass the values as strings ("true";"TRUE";"True"/"false";"FALSE";"False") or integers (1 for true and 0 for false).

attributes
object

Custom attributes (with any names)

tags
Array of strings

Tags can be used to group Client accounts.

Responses

202

Accepted

400

Bad Request

post /clients
https://api.synerise.com/v4/clients

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "email": "testDoc@example.com",
  • "phone": "234564560223445",
  • "customId": "string",
  • "firstName": "Dummy",
  • "lastName": "McDummyface",
  • "displayName": "Dummy",
  • "uuid": "b3f56868-9667-4843-a8e5-0509456baa9b",
  • "avatarUrl": null,
  • "birthDate": "1990-07-11",
  • "company": "Synerise API Docs",
  • "city": "Cracow",
  • "address": "Fictional Street",
  • "zipCode": "38-128",
  • "province": "malopolskie",
  • "countryCode": "PL",
  • "sex": "NOT_SPECIFIED",
  • "agreements":
    {