Accountcentral API (1.5.0)
Download OpenAPI specification:Download
Get user basic information for API use
Search and retrive basic user information
Authorizations:
Responses
Response samples
- 200
{- "userPk": 0,
- "name": "string",
- "surname": "string",
- "username": "string",
- "email": "string",
- "picture": "string",
- "lang": "string",
- "timezone": "string",
- "creationGroupPk": 0,
- "creationGroupName": "string",
- "external": true,
- "roles": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Verify that a user is associated with a customer
Verify that the user identified by the authentication token is associated with a customer
Authorizations:
path Parameters
groupPk required | integer target groupPk |
Responses
Response samples
- 200
{- "groupPk": 0,
- "groupName": "string",
- "status": "ACTIVE",
- "chatEnabled": true
}
Get user basic information
Search and retrive basic information for an user. Use the query parameter 'expand=platform' to get info about groups, workspaces and nodes
Authorizations:
query Parameters
expand | string section to be expanded: set 'expand=platform' to get platform section data |
Responses
Response samples
- 200
{- "userPk": 0,
- "name": "string",
- "surname": "string",
- "username": "string",
- "email": "string",
- "picture": "string",
- "lang": "string",
- "timezone": "string",
- "creationGroupPk": 0,
- "creationGroupName": "string",
- "external": true,
- "roles": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "platform": {
- "groups": [
- {
- "kind": "mc",
- "id": 12,
- "name": "Company A"
}
]
}
}
Get user personal info
Search and retrive personal info for an user
Authorizations:
Responses
Response samples
- 200
{- "userPk": 0,
- "name": "string",
- "surname": "string",
- "username": "string",
- "email": "string",
- "groupName": "string",
- "phone": "string",
- "cellPhone": "string",
- "dateOfBirth": "string",
- "sex": "string",
- "cellPhoneVerified": true,
- "status": "ACTIVE",
- "userType": "INTERACTIVE"
}
Update user personal info
Update personal info for an user
Authorizations:
Request Body schema: application/jsonrequired
userPk | integer |
name | string |
surname | string |
username | string cannot be changed |
string | |
groupName | string |
phone | string |
cellPhone | string |
dateOfBirth | string |
sex | string M for Male, F for Female |
cellPhoneVerified | boolean |
status | string Enum: "ACTIVE" "SUSPENDED" "DISABLED"
|
userType | string Enum: "INTERACTIVE" "APPLICATION"
|
Responses
Request samples
- Payload
{- "userPk": 0,
- "name": "string",
- "surname": "string",
- "username": "string",
- "email": "string",
- "groupName": "string",
- "phone": "string",
- "cellPhone": "string",
- "dateOfBirth": "string",
- "sex": "string",
- "cellPhoneVerified": true,
- "status": "ACTIVE",
- "userType": "INTERACTIVE"
}
Response samples
- 200
- 400
{- "userPk": 0,
- "name": "string",
- "surname": "string",
- "username": "string",
- "email": "string",
- "groupName": "string",
- "phone": "string",
- "cellPhone": "string",
- "dateOfBirth": "string",
- "sex": "string",
- "cellPhoneVerified": true,
- "status": "ACTIVE",
- "userType": "INTERACTIVE"
}
Get user preferences
Search and retrive preferences for an user
Authorizations:
Responses
Response samples
- 200
{- "timezone": "string",
- "language": "string",
- "weekBegin": "string",
- "numberFormat": {
- "decimal": "string",
- "grouping": "string"
}, - "dateFormat": {
- "separator": "string",
- "order": "string"
}, - "hourFormat": {
- "format": "string",
- "type": "string"
}
}
Update user preferences
Update preferences for an user
Authorizations:
Request Body schema: application/jsonrequired
timezone | string |
language | string |
weekBegin | string |
object | |
object | |
object |
Responses
Request samples
- Payload
{- "timezone": "string",
- "language": "string",
- "weekBegin": "string",
- "numberFormat": {
- "decimal": "string",
- "grouping": "string"
}, - "dateFormat": {
- "separator": "string",
- "order": "string"
}, - "hourFormat": {
- "format": "string",
- "type": "string"
}
}
Response samples
- 200
- 400
{- "timezone": "string",
- "language": "string",
- "weekBegin": "string",
- "numberFormat": {
- "decimal": "string",
- "grouping": "string"
}, - "dateFormat": {
- "separator": "string",
- "order": "string"
}, - "hourFormat": {
- "format": "string",
- "type": "string"
}
}
Get user security events
Search and retrive security events for an user, order by date descending
Authorizations:
query Parameters
size | integer maximum elements to be retrieved |
page | integer page |
type | string filter events by type |
exclude-app | Array of strings exclude apps from the events |
from | integer date from |
to | integer date to |
Responses
Response samples
- 200
- 400
[- {
- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "idEvent": 0,
- "userPk": 0,
- "timestamp": 0,
- "ip": "string",
- "country": "string",
- "deviceName": "string",
- "deviceType": "string",
- "operatingSystem": "string",
- "operatingSystemVersion": "string",
- "browser": "string",
- "browserVersion": "string",
- "destinationApp": "string",
- "eventType": "string"
}
]
}
]
Get first and last access for all apps used
Get first and last access for all apps used
Authorizations:
Responses
Response samples
- 200
{- "property1": {
- "firstAccess": "string",
- "lastAccess": "string"
}, - "property2": {
- "firstAccess": "string",
- "lastAccess": "string"
}
}
change password
change the old password with a new valid one
Authorizations:
Request Body schema: application/jsonrequired
oldPassword required | string the old password |
newPassword required | string the new password |
Responses
Request samples
- Payload
{- "oldPassword": "string",
- "newPassword": "string"
}
Response samples
- 400
{- "message": "string",
- "logref": "string",
- "data": { },
- "errors": [
- {
- "path": "string",
- "message": "string",
- "code": "string",
- "data": { }
}
]
}
verify verification code
verify that the verification code is correct and code lifetime is less than 10 min
Authorizations:
Request Body schema: application/jsonrequired
code required | integer verification code |
Responses
Request samples
- Payload
{- "code": 0
}
Response samples
- 200
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
activate/deactivate two factor for pin
Authorizations:
Request Body schema: application/jsonrequired
active | boolean two factor status |
Responses
Request samples
- Payload
{- "active": true
}
Response samples
- 200
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
Response samples
- 200
{- "timezones": [
- {
- "id": "string",
- "hourOffset": 0,
- "offset": 0,
- "dstSavings": "string",
- "useDayligth": true
}
], - "weekBegin": [
- "string"
], - "languages": [
- {
- "label": "string",
- "value": "string"
}
], - "numberFormat": {
- "decimal": [
- {
- "value": "string",
- "example": "string"
}
], - "grouping": [
- {
- "value": "string",
- "example": "string"
}
]
}, - "dateFormat": {
- "separator": [
- {
- "value": "string",
- "example": "string"
}
], - "order": [
- {
- "value": "string",
- "example": "string"
}
]
}, - "hourFormat": {
- "format": [
- {
- "value": "string",
- "example": "string"
}
], - "type": [
- {
- "value": "string",
- "example": "string"
}
]
}
}
User role for account AccountCentral
Returns the user role in AccountCentral for the given customer. The role is assigned to specific customer using the user capabilities.
Authorizations:
query Parameters
groupPk | integer |
Responses
Response samples
- 200
{- "role": "CUSTOMER_CARE"
}
Get user security events
Search and retrive security events for an user, order by date descending
Authorizations:
query Parameters
size | integer maximum elements to be retrieved |
page | integer page |
type | string filter events by type |
exclude-app | Array of strings exclude apps from the events |
from | integer date from |
to | integer date to |
Responses
Response samples
- 200
- 400
[- {
- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "idEvent": 0,
- "userPk": 0,
- "timestamp": 0,
- "ip": "string",
- "country": "string",
- "deviceName": "string",
- "deviceType": "string",
- "operatingSystem": "string",
- "operatingSystemVersion": "string",
- "browser": "string",
- "browserVersion": "string",
- "destinationApp": "string",
- "eventType": "string"
}
]
}
]
Get first and last access for all apps used
Get first and last access for all apps used
Authorizations:
Responses
Response samples
- 200
{- "property1": {
- "firstAccess": "string",
- "lastAccess": "string"
}, - "property2": {
- "firstAccess": "string",
- "lastAccess": "string"
}
}
change password
change the old password with a new valid one
Authorizations:
Request Body schema: application/jsonrequired
oldPassword required | string the old password |
newPassword required | string the new password |
Responses
Request samples
- Payload
{- "oldPassword": "string",
- "newPassword": "string"
}
Response samples
- 400
{- "message": "string",
- "logref": "string",
- "data": { },
- "errors": [
- {
- "path": "string",
- "message": "string",
- "code": "string",
- "data": { }
}
]
}
verify verification code
verify that the verification code is correct and code lifetime is less than 10 min
Authorizations:
Request Body schema: application/jsonrequired
code required | integer verification code |
Responses
Request samples
- Payload
{- "code": 0
}
Response samples
- 200
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
activate/deactivate two factor for pin
Authorizations:
Request Body schema: application/jsonrequired
active | boolean two factor status |
Responses
Request samples
- Payload
{- "active": true
}
Response samples
- 200
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
Security events for a single user
Get security events for the specified user
Authorizations:
path Parameters
userPk required | integer |
query Parameters
size | integer maximum elements to be retrieved |
page | integer page |
type | string filter events by type |
from | integer date from |
to | integer date to |
Responses
Response samples
- 200
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "idEvent": 0,
- "userPk": 0,
- "timestamp": 0,
- "ip": "string",
- "country": "string",
- "deviceName": "string",
- "deviceType": "string",
- "operatingSystem": "string",
- "operatingSystemVersion": "string",
- "browser": "string",
- "browserVersion": "string",
- "destinationApp": "string",
- "eventType": "string"
}
]
}
Get users associated with owned customers that have failed logins
Return list of users of a customer/sub-customers that have failed logins and serveral consecutive failed logins
Authorizations:
path Parameters
groupPk required | integer target groupPk |
query Parameters
size | integer maximum user in the page |
page | integer page to return |
sort | string |
days | integer specify the range to check the logins can be from 1 to 30 days |
Responses
Response samples
- 200
- 400
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "userPk": 0,
- "name": "string",
- "surname": "string",
- "username": "string",
- "email": "string",
- "groupName": "string",
- "failedLogins": {
- "count": 0,
- "oldestEventTimestamp": 0,
- "latestEventTimestamp": 0,
- "elements": [
- {
- "idEvent": 0,
- "userPk": 0,
- "timestamp": 0,
- "ip": "string",
- "country": "string",
- "destinationApp": "string",
- "eventType": "string",
- "browser": "string",
- "browserVersion": "string",
- "deviceName": "string",
- "deviceType": "string",
- "operatingSystem": "string",
- "operatingSystemVersion": "string"
}
]
}, - "maxConsecutiveFailedLogins": {
- "count": 0,
- "elements": [
- {
- "idEvent": 0,
- "userPk": 0,
- "timestamp": 0,
- "ip": "string",
- "country": "string",
- "destinationApp": "string",
- "eventType": "string",
- "browser": "string",
- "browserVersion": "string",
- "deviceName": "string",
- "deviceType": "string",
- "operatingSystem": "string",
- "operatingSystemVersion": "string"
}
]
}
}
]
}
request a verification code for specific user
request a verification code for user mobile number that will be sent by sms
Authorizations:
path Parameters
userPk required | integer |
Responses
Response samples
- 200
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
verify verification code for a user
verify that the verification code is correct and code lifetime is less than 10 min
Authorizations:
path Parameters
userPk required | integer |
Request Body schema: application/jsonrequired
code required | integer verification code |
Responses
Request samples
- Payload
{- "code": 0
}
Response samples
- 200
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
activate/deactivate two factor for pin for a specific user
Authorizations:
path Parameters
userPk required | integer |
Request Body schema: application/jsonrequired
active | boolean two factor status |
Responses
Request samples
- Payload
{- "active": true
}
Response samples
- 200
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
Get info user
Get info about an user of the team
Authorizations:
path Parameters
userPk required | integer |
Responses
Response samples
- 200
- 400
{- "userPk": 0,
- "name": "string",
- "surname": "string",
- "username": "string",
- "email": "string",
- "groupName": "string",
- "phone": "string",
- "cellPhone": "string",
- "dateOfBirth": "string",
- "sex": "string",
- "cellPhoneVerified": true,
- "status": "ACTIVE",
- "userType": "INTERACTIVE",
- "suspensionInfo": {
- "date": "string",
- "reason": "PIN",
- "suspendedBy": {
- "userPk": 0,
- "name": "string",
- "surname": "string"
}
}
}
Modify info of user
Modify info about an user of the team
Authorizations:
path Parameters
userPk required | integer |
Request Body schema: application/jsonrequired
userPk | integer |
name | string |
surname | string |
username | string cannot be changed |
string | |
groupName | string |
phone | string |
cellPhone | string |
dateOfBirth | string |
sex | string M for Male, F for Female |
cellPhoneVerified | boolean |
status | string Enum: "ACTIVE" "SUSPENDED" "DISABLED"
|
userType | string Enum: "INTERACTIVE" "APPLICATION"
|
Responses
Request samples
- Payload
{- "userPk": 0,
- "name": "string",
- "surname": "string",
- "username": "string",
- "email": "string",
- "groupName": "string",
- "phone": "string",
- "cellPhone": "string",
- "dateOfBirth": "string",
- "sex": "string",
- "cellPhoneVerified": true,
- "status": "ACTIVE",
- "userType": "INTERACTIVE"
}
Response samples
- 200
- 400
{- "userPk": 0,
- "name": "string",
- "surname": "string",
- "username": "string",
- "email": "string",
- "groupName": "string",
- "phone": "string",
- "cellPhone": "string",
- "dateOfBirth": "string",
- "sex": "string",
- "cellPhoneVerified": true,
- "status": "ACTIVE",
- "userType": "INTERACTIVE"
}
suspend or reactivate a user
Authorizations:
path Parameters
userPk required | integer |
Request Body schema: application/jsonrequired
suspended | boolean true to suspend, false to reactivate |
Responses
Request samples
- Payload
{- "suspended": true
}
Response samples
- 200
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
Get associated customers
Get the list of associated customers for a user
Authorizations:
path Parameters
userPk required | integer |
query Parameters
size | integer maximum elements to be retrieved |
page | integer page |
groupName | string value of the filter over groupName field |
groupNameMode | string mode of the filter. | startsWith - search string stating with filter value default is containing |
Responses
Response samples
- 200
- 400
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "groupPk": 0,
- "groupName": "string",
- "status": "ACTIVE",
- "chatEnabled": true
}
]
}
Associate customers
Associate a list of customers to an user
Authorizations:
path Parameters
userPk required | integer |
Request Body schema: application/jsonrequired
id to be associated
Responses
Request samples
- Payload
[- 0
]
Response samples
- 200
- 400
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
Get user preferences
Search and retrive preferences for an user of the team
Authorizations:
path Parameters
userPk required | integer |
Responses
Response samples
- 200
{- "timezone": "string",
- "language": "string",
- "weekBegin": "string",
- "numberFormat": {
- "decimal": "string",
- "grouping": "string"
}, - "dateFormat": {
- "separator": "string",
- "order": "string"
}, - "hourFormat": {
- "format": "string",
- "type": "string"
}
}
Update user preferences
Update preferences for an user of the team
Authorizations:
path Parameters
userPk required | integer |
Request Body schema: application/jsonrequired
timezone | string |
language | string |
weekBegin | string |
object | |
object | |
object |
Responses
Request samples
- Payload
{- "timezone": "string",
- "language": "string",
- "weekBegin": "string",
- "numberFormat": {
- "decimal": "string",
- "grouping": "string"
}, - "dateFormat": {
- "separator": "string",
- "order": "string"
}, - "hourFormat": {
- "format": "string",
- "type": "string"
}
}
Response samples
- 200
- 400
{- "timezone": "string",
- "language": "string",
- "weekBegin": "string",
- "numberFormat": {
- "decimal": "string",
- "grouping": "string"
}, - "dateFormat": {
- "separator": "string",
- "order": "string"
}, - "hourFormat": {
- "format": "string",
- "type": "string"
}
}
Security events for a single user
Get security events for the specified user
Authorizations:
path Parameters
userPk required | integer |
query Parameters
size | integer maximum elements to be retrieved |
page | integer page |
type | string filter events by type |
from | integer date from |
to | integer date to |
Responses
Response samples
- 200
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "idEvent": 0,
- "userPk": 0,
- "timestamp": 0,
- "ip": "string",
- "country": "string",
- "deviceName": "string",
- "deviceType": "string",
- "operatingSystem": "string",
- "operatingSystemVersion": "string",
- "browser": "string",
- "browserVersion": "string",
- "destinationApp": "string",
- "eventType": "string"
}
]
}
Assign roles
Assign roles for hub, plan and flow applications. Apply pattern for send roles.
Authorizations:
path Parameters
userPk required | integer |
Request Body schema: application/jsonrequired
accountcentral | string the role to assign for the accountcentral application. |
hub | string the role to assign for the ContactHub application |
mc | string the role to assign for the marketing cloud application |
cplan | string the role to assign for the ContactPlan application |
send | string the role to assign for the ContactSend application |
content | string the role to assign for the content provider application |
flow | string the role to assign for the ContactFlow application |
eddie | string the role to assign for the EmailDesigner application |
demo_client | string the role to assign for the jquery demo client |
Responses
Request samples
- Payload
{- "accountcentral": "string",
- "hub": "string",
- "mc": "string",
- "cplan": "string",
- "send": "string",
- "content": "string",
- "flow": "string",
- "eddie": "string",
- "demo_client": "string"
}
Response samples
- 400
{- "message": "string",
- "logref": "string",
- "data": { },
- "errors": [
- {
- "path": "string",
- "message": "string",
- "code": "string",
- "data": { }
}
]
}
request a verification code for specific user
request a verification code for user mobile number that will be sent by sms
Authorizations:
path Parameters
userPk required | integer |
Responses
Response samples
- 200
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
verify verification code for a user
verify that the verification code is correct and code lifetime is less than 10 min
Authorizations:
path Parameters
userPk required | integer |
Request Body schema: application/jsonrequired
code required | integer verification code |
Responses
Request samples
- Payload
{- "code": 0
}
Response samples
- 200
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
activate/deactivate two factor for pin for a specific user
Authorizations:
path Parameters
userPk required | integer |
Request Body schema: application/jsonrequired
active | boolean two factor status |
Responses
Request samples
- Payload
{- "active": true
}
Response samples
- 200
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
Grant capability
Grant the given capability to the user
Authorizations:
path Parameters
userPk required | integer |
Request Body schema: application/jsonrequired
application | string client id of the application |
version | integer version of the capabilities schema for the application |
resource | Array of strings path of the resource for the given capabilities schema |
role | string role granted to the resource |
Responses
Request samples
- Payload
{- "application": "string",
- "version": 0,
- "resource": [
- "string"
], - "role": "string"
}
Response samples
- 201
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
User capability log
Return the history of all capabilities granted and revoked to the user
Authorizations:
path Parameters
userPk required | integer |
Responses
Response samples
- 200
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "id": 0,
- "application": "string",
- "version": 0,
- "resource": [
- "string"
], - "role": "string",
- "operation": "GRANT",
- "versionDate": "string",
- "versionBy": {
- "userPk": 0,
- "name": "string",
- "surname": "string"
}
}
]
}
Get associated customers
Get the list of associated customers for a user
Authorizations:
path Parameters
userPk required | integer |
query Parameters
size | integer maximum elements to be retrieved |
page | integer page |
groupName | string value of the filter over groupName field |
groupNameMode | string mode of the filter. | startsWith - search string stating with filter value default is containing |
Responses
Response samples
- 200
- 400
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "groupPk": 0,
- "groupName": "string",
- "status": "ACTIVE",
- "chatEnabled": true
}
]
}
Associate customers
Associate a list of customers to an user
Authorizations:
path Parameters
userPk required | integer |
Request Body schema: application/jsonrequired
id to be associated
Responses
Request samples
- Payload
[- 0
]
Response samples
- 200
- 400
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
Get customers
Return list of customers associated with logged user
Authorizations:
query Parameters
size | integer maximum customers in the page |
page | integer page to return |
name | string filter for group name |
excludeUserPk | integer exclude all groups associated to the userPk |
Responses
Response samples
- 200
- 400
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "groupPk": 0,
- "groupName": "string",
- "status": "ACTIVE",
- "chatEnabled": true
}
]
}
Get customers
Return list of parents of the selected customer
Authorizations:
path Parameters
groupPk required | integer target groupPk |
query Parameters
size | integer maximum customers in the page |
page | integer page to return |
name | string filter for group name |
excludeUserPk | integer exclude all groups associated to the userPk |
Responses
Response samples
- 200
- 400
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "groupPk": 0,
- "groupName": "string",
- "status": "ACTIVE",
- "chatEnabled": true
}
]
}
Get customer
Return full info for customer
Authorizations:
path Parameters
groupPk required | integer target groupPk |
Responses
Response samples
- 200
- 400
{- "name": "string",
- "address": "string",
- "country": "string",
- "phone": "string",
- "platformResponsible": "string",
- "technicalResponsible": "string",
- "privacyResponsible": "string",
- "status": "ACTIVE",
- "premium": true,
- "gid": "string"
}
Update customer
Update info of customer
Authorizations:
path Parameters
groupPk required | integer customer to update |
Request Body schema: application/jsonrequired
name | string name of customer |
address | string address of the customer |
country | string country of the customer |
phone | string phone number of the customer |
platformResponsible | string email of the platform responsible |
technicalResponsible | string email of the technical responsible |
privacyResponsible | string email of the privacy responsible |
status | string Enum: "ACTIVE" "SUSPENDED" "INACTIVE" |
premium | boolean |
gid | string group id of customer |
Responses
Request samples
- Payload
{- "name": "string",
- "address": "string",
- "country": "string",
- "phone": "string",
- "platformResponsible": "string",
- "technicalResponsible": "string",
- "privacyResponsible": "string",
- "status": "ACTIVE",
- "premium": true,
- "gid": "string"
}
Response samples
- 200
- 400
{- "name": "string",
- "address": "string",
- "country": "string",
- "phone": "string",
- "platformResponsible": "string",
- "technicalResponsible": "string",
- "privacyResponsible": "string",
- "status": "ACTIVE",
- "premium": true,
- "gid": "string"
}
Partial update customer (only status)
Update status of customer
Authorizations:
path Parameters
groupPk required | integer customer to update |
Request Body schema: application/jsonrequired
status | string Enum: "ACTIVE" "SUSPENDED" "INACTIVE" |
Responses
Request samples
- Payload
{- "status": "ACTIVE"
}
Response samples
- 200
- 400
{- "name": "string",
- "address": "string",
- "country": "string",
- "phone": "string",
- "platformResponsible": "string",
- "technicalResponsible": "string",
- "privacyResponsible": "string",
- "status": "ACTIVE",
- "premium": true,
- "gid": "string"
}
Get users associated with owned customers
Return list of users of a customer/sub-customers
Authorizations:
path Parameters
groupPk required | integer target groupPk |
query Parameters
size | integer maximum user in the page |
page | integer page to return |
sort | string sort by column, by default asc sorting |
search | string fulltext search in name, surname, username or email |
userType | string Enum: "INTERACTIVE" "APPLICATION" when present, filter on user type:
|
status | string Enum: "ACTIVE" "SUSPENDED" "DISABLED" when present, filter on on user status:
|
Responses
Response samples
- 200
- 400
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "userPk": 0,
- "name": "string",
- "surname": "string",
- "email": "string",
- "username": "string",
- "groupName": 0,
- "readOnly": true,
- "status": "ACTIVE",
- "userType": "INTERACTIVE",
- "lastLogin": 0
}
]
}
Create user
Create user associated with customer
Authorizations:
path Parameters
groupPk required | integer target groupPk |
Request Body schema: application/jsonrequired
data for user creation
username required | string |
name required | string |
surname required | string |
email required | string |
language required | string |
sex required | string |
send | string SEND role to assign to the new user, can be 'default' 'noSend', 'onlyStat'. | if null the user will have blank permission |
hub | string role for HUB |
cplan | string role for PLAN |
flow | string role for FLOW |
Responses
Request samples
- Payload
{- "username": "string",
- "name": "string",
- "surname": "string",
- "email": "string",
- "language": "string",
- "sex": "string",
- "send": "string",
- "hub": "string",
- "cplan": "string",
- "flow": "string"
}
Response samples
- 201
- 400
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
Get application users associated with owned customers with secret creation informations
Return list of application users of a customer with secret creation information
Authorizations:
path Parameters
groupPk required | integer target groupPk |
query Parameters
size | integer maximum user in the page |
page | integer page to return |
sort | string sort by column, by default asc sorting |
Responses
Response samples
- 200
- 400
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "uid": "string",
- "username": "string",
- "status": "ACTIVE",
- "creationDate": 0,
- "secretCreationDate": 0,
- "secretCreatedBy": {
- "userPk": 0,
- "name": "string",
- "surname": "string"
}
}
]
}
List of users that have used any application for a customer
Return list of users that have used any application for a customer and the first and last access time
Authorizations:
path Parameters
groupPk required | integer target groupPk |
query Parameters
size | integer maximum user in the page |
page | integer page to return |
Responses
Response samples
- 200
- 400
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "userPk": 0,
- "name": "string",
- "surname": "string",
- "email": "string",
- "username": "string",
- "groupName": "string",
- "loginInfo": {
- "property1": { },
- "property2": { }
}
}
]
}
List of users that have used an application for a customer
Return list of users that have used an application for a customer and the first and last access time
Authorizations:
path Parameters
groupPk required | integer target groupPk |
application required | string application used for the customer (cdata, cplan, flow, hub, send, srr) |
query Parameters
size | integer maximum user in the page |
page | integer page to return |
Responses
Response samples
- 200
- 400
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "userPk": 0,
- "name": "string",
- "surname": "string",
- "email": "string",
- "username": "string",
- "groupName": "string",
- "loginInfo": {
- "firstAccess": 0,
- "lastAccess": 0
}
}
]
}
Get users associated with owned customers that have issues
Return list of users of a customer/sub-customers that have issues
Authorizations:
path Parameters
groupPk required | integer target groupPk |
query Parameters
size | integer maximum user in the page |
page | integer page to return |
sort | string sort by column, by default asc sorting |
Responses
Response samples
- 200
- 400
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "userPk": 0,
- "name": "string",
- "surname": "string",
- "email": "string",
- "username": "string",
- "groupName": 0,
- "issues": [
- "string"
]
}
]
}
Get users associated with owned customers that have failed logins
Return list of users of a customer/sub-customers that have failed logins and serveral consecutive failed logins
Authorizations:
path Parameters
groupPk required | integer target groupPk |
query Parameters
size | integer maximum user in the page |
page | integer page to return |
sort | string |
days | integer specify the range to check the logins can be from 1 to 30 days |
Responses
Response samples
- 200
- 400
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "userPk": 0,
- "name": "string",
- "surname": "string",
- "username": "string",
- "email": "string",
- "groupName": "string",
- "failedLogins": {
- "count": 0,
- "oldestEventTimestamp": 0,
- "latestEventTimestamp": 0,
- "elements": [
- {
- "idEvent": 0,
- "userPk": 0,
- "timestamp": 0,
- "ip": "string",
- "country": "string",
- "destinationApp": "string",
- "eventType": "string",
- "browser": "string",
- "browserVersion": "string",
- "deviceName": "string",
- "deviceType": "string",
- "operatingSystem": "string",
- "operatingSystemVersion": "string"
}
]
}, - "maxConsecutiveFailedLogins": {
- "count": 0,
- "elements": [
- {
- "idEvent": 0,
- "userPk": 0,
- "timestamp": 0,
- "ip": "string",
- "country": "string",
- "destinationApp": "string",
- "eventType": "string",
- "browser": "string",
- "browserVersion": "string",
- "deviceName": "string",
- "deviceType": "string",
- "operatingSystem": "string",
- "operatingSystemVersion": "string"
}
]
}
}
]
}
Get customer configuration
Return customer configuration
Authorizations:
path Parameters
groupPk required | integer target groupPk |
Responses
Response samples
- 200
- 400
{- "gid": "string",
- "apiKey": {
- "value": "string",
- "enable": true
}, - "smartRelayEnable": true,
- "genericUsers": [
- {
- "username": "string",
- "email": "string",
- "uid": "string"
}
], - "dataExchanges": [
- {
- "configId": 0,
- "name": "string",
- "app": "string",
- "lastExecutionDate": "string",
- "status": 0
}
]
}
Get customer configuration for sftp
Authorizations:
path Parameters
groupPk required | integer target groupPk |
Responses
Response samples
- 200
- 400
[- {
- "name": "string",
- "updatedOn": 0,
- "createdOn": 0,
- "port": 0,
- "proto": "string",
- "host": "string",
- "ip": [
- "string"
], - "user": "string",
- "publicKey": "string"
}
]
Get customer applications configurations
Return customer applications configurations
Authorizations:
path Parameters
groupPk required | integer target groupPk |
Responses
Response samples
- 200
{- "hub": {
- "configured": true,
- "workspaces": [
- {
- "id": "string",
- "name": "string",
- "status": "string",
- "nodes": [
- {
- "type": "entry",
- "id": "string",
- "name": "string",
- "planSource": {
- "id": "string",
- "name": "string",
- "groupPk": 0,
- "groupName": "string",
- "userDbId": 0,
- "userDbName": "string"
}, - "sendSource": {
- "id": "string",
- "name": "string",
- "groupPk": 0,
- "groupName": "string",
- "userDbId": 0,
- "userDbName": "string"
}, - "otherSources": [
- {
- "id": "string",
- "name": "string",
- "type": "string"
}
], - "children": [
- {
- "type": "entry",
- "id": "string",
- "name": "string"
}
], - "entries": [
- {
- "type": "entry",
- "id": "string",
- "name": "string"
}
], - "matchingProperties": [
- "string"
]
}
]
}
]
}, - "plan": {
- "configured": true,
- "tenants": [
- {
- "id": 0,
- "label": "string",
- "groupPk": 0,
- "userDbId": 0,
- "userDbName": "string",
- "creationDate": "string",
- "blacklistedUsersCount": 0
}
]
}, - "send": {
- "userDbs": [
- {
- "id": 0,
- "name": "string",
- "usersCount": 0,
- "baseFilteredUsersCount": 0
}
]
}
}
Get the counters for an hub workspace
Get the counters for nodes and sources in an hub workspace
Authorizations:
path Parameters
groupPk required | integer target groupPk |
workspaceId required | integer target workspaceId |
query Parameters
nodes | Array of integers nodes to be considered |
Responses
Response samples
- 200
{- "data": [
- {
- "nodeId": "string",
- "count": 0,
- "values": [
- {
- "count": 0,
- "sourceId": "string"
}
]
}
]
}
Get customers dkims
Return customer dkims.
Authorizations:
path Parameters
groupPk required | integer target groupPk |
query Parameters
size | integer maximum items in the page |
page | integer page to return |
domain | string Filter the dkims by the specified domain |
default | boolean Filter the dkims by the specified value |
active | boolean Filter the dkims by active value |
Responses
Response samples
- 200
- 400
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "id": 0,
- "domain": "string",
- "selector": "string",
- "publicKey": "string",
- "privateKey": "string",
- "alignment": "EXACT",
- "default": true
}
]
}
Register a new dkim
Register a new dkim
Authorizations:
path Parameters
groupPk required | integer target groupPk |
Request Body schema: application/jsonrequired
domain required | string |
selector required | string |
publicKey required | string |
privateKey required | string |
active required | boolean |
Responses
Request samples
- Payload
{- "domain": "string",
- "selector": "string",
- "publicKey": "string",
- "privateKey": "string",
- "active": true
}
Response samples
- 201
- 400
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
Update dkim
Update dkim.
Authorizations:
path Parameters
groupPk required | integer target groupPk |
dkimId required | integer dkim id |
Request Body schema: application/jsonrequired
domain required | string |
selector required | string |
publicKey required | string |
privateKey required | string |
active required | boolean |
Responses
Request samples
- Payload
{- "domain": "string",
- "selector": "string",
- "publicKey": "string",
- "privateKey": "string",
- "active": true
}
Response samples
- 200
- 400
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
Get customer applications configurations
Return customer applications configurations
Authorizations:
path Parameters
groupPk required | integer target groupPk |
Responses
Response samples
- 200
{- "hub": {
- "configured": true,
- "workspaces": [
- {
- "id": "string",
- "name": "string",
- "status": "string",
- "nodes": [
- {
- "type": "entry",
- "id": "string",
- "name": "string",
- "planSource": {
- "id": "string",
- "name": "string",
- "groupPk": 0,
- "groupName": "string",
- "userDbId": 0,
- "userDbName": "string"
}, - "sendSource": {
- "id": "string",
- "name": "string",
- "groupPk": 0,
- "groupName": "string",
- "userDbId": 0,
- "userDbName": "string"
}, - "otherSources": [
- {
- "id": "string",
- "name": "string",
- "type": "string"
}
], - "children": [
- {
- "type": "entry",
- "id": "string",
- "name": "string"
}
], - "entries": [
- {
- "type": "entry",
- "id": "string",
- "name": "string"
}
], - "matchingProperties": [
- "string"
]
}
]
}
]
}, - "plan": {
- "configured": true,
- "tenants": [
- {
- "id": 0,
- "label": "string",
- "groupPk": 0,
- "userDbId": 0,
- "userDbName": "string",
- "creationDate": "string",
- "blacklistedUsersCount": 0
}
]
}, - "send": {
- "userDbs": [
- {
- "id": 0,
- "name": "string",
- "usersCount": 0,
- "baseFilteredUsersCount": 0
}
]
}
}
Get the counters for an hub workspace
Get the counters for nodes and sources in an hub workspace
Authorizations:
path Parameters
groupPk required | integer target groupPk |
workspaceId required | integer target workspaceId |
query Parameters
nodes | Array of integers nodes to be considered |
Responses
Response samples
- 200
{- "data": [
- {
- "nodeId": "string",
- "count": 0,
- "values": [
- {
- "count": 0,
- "sourceId": "string"
}
]
}
]
}
Sets status of the application
Authorizations:
path Parameters
application required | string |
Request Body schema: application/jsonrequired
status | string Enum: "UP" "DOWN" Enum, can be "UP" or "DOWN" |
Responses
Request samples
- Payload
{- "status": "UP"
}
Response samples
- 200
{- "result": "string",
- "resultCode": "string",
- "timestamp": 0
}
Subscribes to an application status changes SSE notification
The client application opens an EventSource connection to the path to receive notifications from AccountCentral
Authorizations:
path Parameters
application required | string |
Responses
Response samples
- 200
{- "data": {
- "application": "string",
- "status": "string"
}
}
Get customers dkims
Return customer dkims.
Authorizations:
path Parameters
groupPk required | integer target groupPk |
query Parameters
size | integer maximum items in the page |
page | integer page to return |
domain | string Filter the dkims by the specified domain |
default | boolean Filter the dkims by the specified value |
active | boolean Filter the dkims by active value |
Responses
Response samples
- 200
- 400
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "id": 0,
- "domain": "string",
- "selector": "string",
- "publicKey": "string",
- "privateKey": "string",
- "alignment": "EXACT",
- "default": true
}
]
}
Register a new dkim
Register a new dkim
Authorizations:
path Parameters
groupPk required | integer target groupPk |
Request Body schema: application/jsonrequired
domain required | string |
selector required | string |
publicKey required | string |
privateKey required | string |
active required | boolean |
Responses
Request samples
- Payload
{- "domain": "string",
- "selector": "string",
- "publicKey": "string",
- "privateKey": "string",
- "active": true
}
Response samples
- 201
- 400
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
Get customer dkim by id
Return customer dkim.
Authorizations:
path Parameters
groupPk required | integer target groupPk |
dkimId required | integer dkim id |
Responses
Response samples
- 200
- 400
{- "id": 0,
- "domain": "string",
- "selector": "string",
- "publicKey": "string",
- "privateKey": "string",
- "alignment": "EXACT",
- "default": true
}
Update dkim
Update dkim.
Authorizations:
path Parameters
groupPk required | integer target groupPk |
dkimId required | integer dkim id |
Request Body schema: application/jsonrequired
domain required | string |
selector required | string |
publicKey required | string |
privateKey required | string |
active required | boolean |
Responses
Request samples
- Payload
{- "domain": "string",
- "selector": "string",
- "publicKey": "string",
- "privateKey": "string",
- "active": true
}
Response samples
- 200
- 400
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
Set customer default dkim
Set customer default dkim
Authorizations:
path Parameters
groupPk required | integer target groupPk |
Request Body schema: application/json
id required | integer id of the default dkim |
Responses
Request samples
- Payload
{- "id": 0
}
Response samples
- 200
- 400
{- "timestamp": 0,
- "result": "string",
- "resultCode": "string"
}
Get signing dkim by domain
Returns signing Dkim by domain. Default Dkim is returned if domain is not specified. Platform Dkim is returned if the customer does not have any custom Dkims.
Authorizations:
path Parameters
groupPk required | integer target groupPk |
query Parameters
domain | string sender domain to get the dkim from |
Responses
Response samples
- 200
{- "id": 0,
- "domain": "string",
- "selector": "string",
- "publicKey": "string",
- "privateKey": "string",
- "alignment": "EXACT",
- "default": true
}
Apply the DKIM signature(s) to an email message
Apply the neccessary DKIM signature(s) to an email message. The correct signing key is selected as follows
- If the customer has multiple signing keys the one exactly matching the sender domain is used
- If the cusotmer has only a signing key or if no one of the customer keys matches exacly the sender domain then the customer's default key is used
- If the customer has no key the default for the contactlab platform is used For recipient domain tha need an FBL the relevant signature is applied as well.
path Parameters
groupPk required | integer target groupPk |
Request Body schema: application/json
message required | string the email message to be signed (headers and all) |
required | object (MessageSigningData) |
applyDkim | boolean specify if dkim signing has to be applied (default true) |
applyFbl | boolean specify if the fbl signing has to be applied (defualt true) |
Responses
Request samples
- Payload
{- "message": "string",
- "data": {
- "deliveryId": 0,
- "newsletterId": 0,
- "sender": "string",
- "recipient": "string"
}, - "applyDkim": true,
- "applyFbl": true
}
Response samples
- 200
- 400
{- "message": "string",
- "dkim": {
- "id": 0,
- "domain": "string",
- "selector": "string",
- "publicKey": "string",
- "privateKey": "string",
- "alignment": "EXACT",
- "default": true
}, - "fbl": {
- "id": "string",
- "esp": "string",
- "recipientDomain": "string",
- "signableHeaders": [
- "string"
], - "dkim": {
- "domain": "string",
- "selector": "string",
- "publicKey": "string",
- "privateKey": "string"
}
}
}
Retrieve all customer DKIMs
Retrieve a paged collection of all customer DKIMs. The collection is sorted by acending cusotmer ID and domain name
Authorizations:
query Parameters
page | integer the page to retrieve |
size | integer the page size |
Responses
Response samples
- 200
{- "page": {
- "size": 0,
- "totalElements": 0,
- "totalUnfilteredElements": 0,
- "totalPages": 0,
- "number": 0
}, - "elements": [
- {
- "customerID": 0,
- "customerName": "string",
- "domain": "string",
- "selector": "string",
- "default": true,
- "active": true,
- "versionDate": "string"
}
]
}
Update platform dkim
Update platform dkim
Authorizations:
Request Body schema: application/json
domain required | string |
selector required | string |
publicKey required | string |
privateKey required | string The private key is returned only to DKIM role and is encrypted by AES symmetric algorithm. The field is null for CUSTOMER_CARE role |