Account

Get Account data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}

POST /Account

Create Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}
Edit Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}
Get list of Accounts
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}]}
Get linked entities for Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export Account data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of Account data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of Account data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the Account stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the Account stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge Accounts
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}
Mass follow to Account entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from Account entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

Activities

Get list of Activitiess
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [[]]}

AssociatedProduct

Get AssociatedProduct data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","relatedAssociationId":"string","relatedAssociationName":"string","relatedProductImage":"string"}
Create AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","relatedAssociationId":"string","relatedAssociationName":"string","relatedProductImage":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","relatedAssociationId":"string","relatedAssociationName":"string","relatedProductImage":"string"}
Edit AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","relatedAssociationId":"string","relatedAssociationName":"string","relatedProductImage":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","relatedAssociationId":"string","relatedAssociationName":"string","relatedProductImage":"string"}
Get list of AssociatedProducts
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","relatedAssociationId":"string","relatedAssociationName":"string","relatedProductImage":"string"}]}
Get linked entities for AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export AssociatedProduct data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of AssociatedProduct data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of AssociatedProduct data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the AssociatedProduct stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the AssociatedProduct stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge AssociatedProducts
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","relatedAssociationId":"string","relatedAssociationName":"string","relatedProductImage":"string"}
Mass follow to AssociatedProduct entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from AssociatedProduct entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

Association

Get Association data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}
Create Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}
Edit Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}
Get list of Associations
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}]}
Get linked entities for Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export Association data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of Association data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of Association data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the Association stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the Association stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge Associations
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}
Mass follow to Association entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from Association entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

Attachment

Get Attachment data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"string"}
Create Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"string"}
Edit Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"string"}
Get list of Attachments
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"string"}]}
Get linked entities for Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export Attachment data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of Attachment data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of Attachment data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the Attachment stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the Attachment stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge Attachments
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"string"}
Mass follow to Attachment entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from Attachment entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

Attribute

Get filters data for product entity
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'json'
Get Attribute data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","attributeGroupId":"string","attributeGroupName":"string","code":"string","type":"string","typeValue":"string","isSystem":"bool","isRequired":"bool","isMultiChannel":"bool","sortOrder":"integer","typeValueDeDe":"string","typeValueEnUs":"string"}
Create Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","attributeGroupId":"string","attributeGroupName":"string","code":"string","type":"string","typeValue":"string","isSystem":"bool","isRequired":"bool","isMultiChannel":"bool","sortOrder":"integer","typeValueDeDe":"string","typeValueEnUs":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","attributeGroupId":"string","attributeGroupName":"string","code":"string","type":"string","typeValue":"string","isSystem":"bool","isRequired":"bool","isMultiChannel":"bool","sortOrder":"integer","typeValueDeDe":"string","typeValueEnUs":"string"}
Edit Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","attributeGroupId":"string","attributeGroupName":"string","code":"string","type":"string","typeValue":"string","isSystem":"bool","isRequired":"bool","isMultiChannel":"bool","sortOrder":"integer","typeValueDeDe":"string","typeValueEnUs":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","attributeGroupId":"string","attributeGroupName":"string","code":"string","type":"string","typeValue":"string","isSystem":"bool","isRequired":"bool","isMultiChannel":"bool","sortOrder":"integer","typeValueDeDe":"string","typeValueEnUs":"string"}
Get list of Attributes
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","attributeGroupId":"string","attributeGroupName":"string","code":"string","type":"string","typeValue":"string","isSystem":"bool","isRequired":"bool","isMultiChannel":"bool","sortOrder":"integer","typeValueDeDe":"string","typeValueEnUs":"string"}]}
Get linked entities for Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export Attribute data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of Attribute data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of Attribute data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the Attribute stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the Attribute stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge Attributes
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","attributeGroupId":"string","attributeGroupName":"string","code":"string","type":"string","typeValue":"string","isSystem":"bool","isRequired":"bool","isMultiChannel":"bool","sortOrder":"integer","typeValueDeDe":"string","typeValueEnUs":"string"}
Mass follow to Attribute entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from Attribute entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

AttributeGroup

Get AttributeGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","sortOrder":"integer"}
Create AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","sortOrder":"integer"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","sortOrder":"integer"}
Edit AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","sortOrder":"integer"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","sortOrder":"integer"}
Get list of AttributeGroups
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","sortOrder":"integer"}]}
Get linked entities for AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export AttributeGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of AttributeGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of AttributeGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the AttributeGroup stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the AttributeGroup stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge AttributeGroups
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","sortOrder":"integer"}
Mass follow to AttributeGroup entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from AttributeGroup entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

AuthLogRecord

Edit AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"string"}
Mass update of AuthLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"string"}
Create link for AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Get AuthLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"string"}
Get list of AuthLogRecords
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"string"}]}
Get linked entities for AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export AuthLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass delete of AuthLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Follow the AuthLogRecord stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the AuthLogRecord stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge AuthLogRecords
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"string"}
Mass follow to AuthLogRecord entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from AuthLogRecord entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

AuthToken

Edit AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"token":"string","hash":"string","userId":"string","userName":"string","portalId":"string","portalName":"string","ipAddress":"string","isActive":"bool","lastAccess":"string","createdAt":"string","modifiedAt":"string","assignedUserId":"string","assignedUserName":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"token":"string","hash":"string","userId":"string","userName":"string","portalId":"string","portalName":"string","ipAddress":"string","isActive":"bool","lastAccess":"string","createdAt":"string","modifiedAt":"string","assignedUserId":"string","assignedUserName":"string"}
Mass update of AuthToken data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"token":"string","hash":"string","userId":"string","userName":"string","portalId":"string","portalName":"string","ipAddress":"string","isActive":"bool","lastAccess":"string","createdAt":"string","modifiedAt":"string","assignedUserId":"string","assignedUserName":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"token":"string","hash":"string","userId":"string","userName":"string","portalId":"string","portalName":"string","ipAddress":"string","isActive":"bool","lastAccess":"string","createdAt":"string","modifiedAt":"string","assignedUserId":"string","assignedUserName":"string"}
Create link for AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Get AuthToken data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"token":"string","hash":"string","userId":"string","userName":"string","portalId":"string","portalName":"string","ipAddress":"string","isActive":"bool","lastAccess":"string","createdAt":"string","modifiedAt":"string","assignedUserId":"string","assignedUserName":"string"}
Get list of AuthTokens
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"token":"string","hash":"string","userId":"string","userName":"string","portalId":"string","portalName":"string","ipAddress":"string","isActive":"bool","lastAccess":"string","createdAt":"string","modifiedAt":"string","assignedUserId":"string","assignedUserName":"string"}]}
Get linked entities for AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export AuthToken data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass delete of AuthToken data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Follow the AuthToken stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the AuthToken stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge AuthTokens
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"token":"string","hash":"string","userId":"string","userName":"string","portalId":"string","portalName":"string","ipAddress":"string","isActive":"bool","lastAccess":"string","createdAt":"string","modifiedAt":"string","assignedUserId":"string","assignedUserName":"string"}
Mass follow to AuthToken entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from AuthToken entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

Brand

Get Brand data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","code":"string"}

POST /Brand

Create Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","code":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","code":"string"}
Edit Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","code":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","code":"string"}

GET /Brand

Get list of Brands
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","code":"string"}]}
Get linked entities for Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export Brand data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of Brand data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of Brand data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the Brand stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the Brand stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge Brands
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","code":"string"}
Mass follow to Brand entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from Brand entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

Call

Get Call data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","dateStart":"string","dateEnd":"string","duration":"string","reminders":"string","direction":"string","description":"string","parent":"string","accountId":"string","accountName":"string","acceptanceStatus":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","textTest":"string"}

POST /Call

Create Call
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","dateStart":"string","dateEnd":"string","duration":"string","reminders":"string","direction":"string","description":"string","parent":"string","accountId":"string","accountName":"string","acceptanceStatus":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","textTest":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","dateStart":"string","dateEnd":"string","duration":"string","reminders":"string","direction":"string","description":"string","parent":"string","accountId":"string","accountName":"string","acceptanceStatus":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","textTest":"string"}
Edit Call
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","dateStart":"string","dateEnd":"string","duration":"string","reminders":"string","direction":"string","description":"string","parent":"string","accountId":"string","accountName":"string","acceptanceStatus":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","textTest":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","dateStart":"string","dateEnd":"string","duration":"string","reminders":"string","direction":"string","description":"string","parent":"string","accountId":"string","accountName":"string","acceptanceStatus":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","textTest":"string"}

GET /Call

Get list of Calls
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","dateStart":"string","dateEnd":"string","duration":"string","reminders":"string","direction":"string","description":"string","parent":"string","accountId":"string","accountName":"string","acceptanceStatus":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","textTest":"string"}]}
Get linked entities for Call
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete Call
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export Call data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of Call data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of Call data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for Call
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from Call
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the Call stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the Call stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge Calls
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from Call
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","dateStart":"string","dateEnd":"string","duration":"string","reminders":"string","direction":"string","description":"string","parent":"string","accountId":"string","accountName":"string","acceptanceStatus":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","textTest":"string"}
Mass follow to Call entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from Call entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

Campaign

Get Campaign data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","type":"string","startDate":"string","endDate":"string","description":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","sentCount":"integer","openedCount":"integer","clickedCount":"integer","optedOutCount":"integer","bouncedCount":"integer","hardBouncedCount":"integer","softBouncedCount":"integer","leadCreatedCount":"integer","openedPercentage":"integer","clickedPercentage":"integer","optedOutPercentage":"integer","bouncedPercentage":"integer","revenue":"string","budget":"string","contactsTemplateId":"string","contactsTemplateName":"string","leadsTemplateId":"string","leadsTemplateName":"string","accountsTemplateId":"string","accountsTemplateName":"string","usersTemplateId":"string","usersTemplateName":"string","mailMergeOnlyWithAddress":"bool","revenueCurrency":"string","revenueConverted":"string","budgetCurrency":"string","budgetConverted":"string"}
Create Campaign
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","type":"string","startDate":"string","endDate":"string","description":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","sentCount":"integer","openedCount":"integer","clickedCount":"integer","optedOutCount":"integer","bouncedCount":"integer","hardBouncedCount":"integer","softBouncedCount":"integer","leadCreatedCount":"integer","openedPercentage":"integer","clickedPercentage":"integer","optedOutPercentage":"integer","bouncedPercentage":"integer","revenue":"string","budget":"string","contactsTemplateId":"string","contactsTemplateName":"string","leadsTemplateId":"string","leadsTemplateName":"string","accountsTemplateId":"string","accountsTemplateName":"string","usersTemplateId":"string","usersTemplateName":"string","mailMergeOnlyWithAddress":"bool","revenueCurrency":"string","revenueConverted":"string","budgetCurrency":"string","budgetConverted":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","type":"string","startDate":"string","endDate":"string","description":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","sentCount":"integer","openedCount":"integer","clickedCount":"integer","optedOutCount":"integer","bouncedCount":"integer","hardBouncedCount":"integer","softBouncedCount":"integer","leadCreatedCount":"integer","openedPercentage":"integer","clickedPercentage":"integer","optedOutPercentage":"integer","bouncedPercentage":"integer","revenue":"string","budget":"string","contactsTemplateId":"string","contactsTemplateName":"string","leadsTemplateId":"string","leadsTemplateName":"string","accountsTemplateId":"string","accountsTemplateName":"string","usersTemplateId":"string","usersTemplateName":"string","mailMergeOnlyWithAddress":"bool","revenueCurrency":"string","revenueConverted":"string","budgetCurrency":"string","budgetConverted":"string"}
Edit Campaign
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","type":"string","startDate":"string","endDate":"string","description":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","sentCount":"integer","openedCount":"integer","clickedCount":"integer","optedOutCount":"integer","bouncedCount":"integer","hardBouncedCount":"integer","softBouncedCount":"integer","leadCreatedCount":"integer","openedPercentage":"integer","clickedPercentage":"integer","optedOutPercentage":"integer","bouncedPercentage":"integer","revenue":"string","budget":"string","contactsTemplateId":"string","contactsTemplateName":"string","leadsTemplateId":"string","leadsTemplateName":"string","accountsTemplateId":"string","accountsTemplateName":"string","usersTemplateId":"string","usersTemplateName":"string","mailMergeOnlyWithAddress":"bool","revenueCurrency":"string","revenueConverted":"string","budgetCurrency":"string","budgetConverted":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","type":"string","startDate":"string","endDate":"string","description":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","sentCount":"integer","openedCount":"integer","clickedCount":"integer","optedOutCount":"integer","bouncedCount":"integer","hardBouncedCount":"integer","softBouncedCount":"integer","leadCreatedCount":"integer","openedPercentage":"integer","clickedPercentage":"integer","optedOutPercentage":"integer","bouncedPercentage":"integer","revenue":"string","budget":"string","contactsTemplateId":"string","contactsTemplateName":"string","leadsTemplateId":"string","leadsTemplateName":"string","accountsTemplateId":"string","accountsTemplateName":"string","usersTemplateId":"string","usersTemplateName":"string","mailMergeOnlyWithAddress":"bool","revenueCurrency":"string","revenueConverted":"string","budgetCurrency":"string","budgetConverted":"string"}
Get list of Campaigns
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","type":"string","startDate":"string","endDate":"string","description":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","sentCount":"integer","openedCount":"integer","clickedCount":"integer","optedOutCount":"integer","bouncedCount":"integer","hardBouncedCount":"integer","softBouncedCount":"integer","leadCreatedCount":"integer","openedPercentage":"integer","clickedPercentage":"integer","optedOutPercentage":"integer","bouncedPercentage":"integer","revenue":"string","budget":"string","contactsTemplateId":"string","contactsTemplateName":"string","leadsTemplateId":"string","leadsTemplateName":"string","accountsTemplateId":"string","accountsTemplateName":"string","usersTemplateId":"string","usersTemplateName":"string","mailMergeOnlyWithAddress":"bool","revenueCurrency":"string","revenueConverted":"string","budgetCurrency":"string","budgetConverted":"string"}]}
Get linked entities for Campaign
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete Campaign
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export Campaign data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of Campaign data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of Campaign data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for Campaign
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from Campaign
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the Campaign stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the Campaign stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge Campaigns
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from Campaign
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","status":"string","type":"string","startDate":"string","endDate":"string","description":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","sentCount":"integer","openedCount":"integer","clickedCount":"integer","optedOutCount":"integer","bouncedCount":"integer","hardBouncedCount":"integer","softBouncedCount":"integer","leadCreatedCount":"integer","openedPercentage":"integer","clickedPercentage":"integer","optedOutPercentage":"integer","bouncedPercentage":"integer","revenue":"string","budget":"string","contactsTemplateId":"string","contactsTemplateName":"string","leadsTemplateId":"string","leadsTemplateName":"string","accountsTemplateId":"string","accountsTemplateName":"string","usersTemplateId":"string","usersTemplateName":"string","mailMergeOnlyWithAddress":"bool","revenueCurrency":"string","revenueConverted":"string","budgetCurrency":"string","budgetConverted":"string"}
Mass follow to Campaign entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from Campaign entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

CampaignLogRecord

Get CampaignLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"action":"string","actionDate":"string","data":"string","stringData":"string","stringAdditionalData":"string","application":"string","createdAt":"string","createdById":"string","createdByName":"string","campaignId":"string","campaignName":"string","parent":"string","object":"string","queueItemId":"string","queueItemName":"string","isTest":"bool"}
Create CampaignLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"action":"string","actionDate":"string","data":"string","stringData":"string","stringAdditionalData":"string","application":"string","createdAt":"string","createdById":"string","createdByName":"string","campaignId":"string","campaignName":"string","parent":"string","object":"string","queueItemId":"string","queueItemName":"string","isTest":"bool"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"action":"string","actionDate":"string","data":"string","stringData":"string","stringAdditionalData":"string","application":"string","createdAt":"string","createdById":"string","createdByName":"string","campaignId":"string","campaignName":"string","parent":"string","object":"string","queueItemId":"string","queueItemName":"string","isTest":"bool"}
Edit CampaignLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"action":"string","actionDate":"string","data":"string","stringData":"string","stringAdditionalData":"string","application":"string","createdAt":"string","createdById":"string","createdByName":"string","campaignId":"string","campaignName":"string","parent":"string","object":"string","queueItemId":"string","queueItemName":"string","isTest":"bool"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"action":"string","actionDate":"string","data":"string","stringData":"string","stringAdditionalData":"string","application":"string","createdAt":"string","createdById":"string","createdByName":"string","campaignId":"string","campaignName":"string","parent":"string","object":"string","queueItemId":"string","queueItemName":"string","isTest":"bool"}
Get list of CampaignLogRecords
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"action":"string","actionDate":"string","data":"string","stringData":"string","stringAdditionalData":"string","application":"string","createdAt":"string","createdById":"string","createdByName":"string","campaignId":"string","campaignName":"string","parent":"string","object":"string","queueItemId":"string","queueItemName":"string","isTest":"bool"}]}
Get linked entities for CampaignLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete CampaignLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export CampaignLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of CampaignLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of CampaignLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for CampaignLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from CampaignLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the CampaignLogRecord stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the CampaignLogRecord stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge CampaignLogRecords
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from CampaignLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"action":"string","actionDate":"string","data":"string","stringData":"string","stringAdditionalData":"string","application":"string","createdAt":"string","createdById":"string","createdByName":"string","campaignId":"string","campaignName":"string","parent":"string","object":"string","queueItemId":"string","queueItemName":"string","isTest":"bool"}
Mass follow to CampaignLogRecord entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from CampaignLogRecord entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

CampaignTrackingUrl

Get CampaignTrackingUrl data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","url":"string","urlToUse":"string","campaignId":"string","campaignName":"string","modifiedAt":"string","modifiedById":"string","modifiedByName":"string","createdAt":"string","createdById":"string","createdByName":"string"}
Create CampaignTrackingUrl
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","url":"string","urlToUse":"string","campaignId":"string","campaignName":"string","modifiedAt":"string","modifiedById":"string","modifiedByName":"string","createdAt":"string","createdById":"string","createdByName":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","url":"string","urlToUse":"string","campaignId":"string","campaignName":"string","modifiedAt":"string","modifiedById":"string","modifiedByName":"string","createdAt":"string","createdById":"string","createdByName":"string"}
Edit CampaignTrackingUrl
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","url":"string","urlToUse":"string","campaignId":"string","campaignName":"string","modifiedAt":"string","modifiedById":"string","modifiedByName":"string","createdAt":"string","createdById":"string","createdByName":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","url":"string","urlToUse":"string","campaignId":"string","campaignName":"string","modifiedAt":"string","modifiedById":"string","modifiedByName":"string","createdAt":"string","createdById":"string","createdByName":"string"}
Get list of CampaignTrackingUrls
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","url":"string","urlToUse":"string","campaignId":"string","campaignName":"string","modifiedAt":"string","modifiedById":"string","modifiedByName":"string","createdAt":"string","createdById":"string","createdByName":"string"}]}
Get linked entities for CampaignTrackingUrl
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete CampaignTrackingUrl
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export CampaignTrackingUrl data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of CampaignTrackingUrl data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of CampaignTrackingUrl data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for CampaignTrackingUrl
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from CampaignTrackingUrl
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the CampaignTrackingUrl stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the CampaignTrackingUrl stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge CampaignTrackingUrls
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from CampaignTrackingUrl
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","url":"string","urlToUse":"string","campaignId":"string","campaignName":"string","modifiedAt":"string","modifiedById":"string","modifiedByName":"string","createdAt":"string","createdById":"string","createdByName":"string"}
Mass follow to CampaignTrackingUrl entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from CampaignTrackingUrl entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

CaseObj

Get CaseObj data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
[]

POST /CaseObj

Create CaseObj
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
[]
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
[]
Edit CaseObj
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
[]
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
[]
Get list of CaseObjs
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [[]]}
Get linked entities for CaseObj
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete CaseObj
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export CaseObj data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of CaseObj data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of CaseObj data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for CaseObj
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from CaseObj
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the CaseObj stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the CaseObj stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge CaseObjs
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from CaseObj
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
[]
Mass follow to CaseObj entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from CaseObj entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

Catalog

Get Catalog data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","isActive":"bool","categoryId":"string","categoryName":"string","ownerUserId":"string","ownerUserName":"string"}

POST /Catalog

Create Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","isActive":"bool","categoryId":"string","categoryName":"string","ownerUserId":"string","ownerUserName":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","isActive":"bool","categoryId":"string","categoryName":"string","ownerUserId":"string","ownerUserName":"string"}
Edit Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","isActive":"bool","categoryId":"string","categoryName":"string","ownerUserId":"string","ownerUserName":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","isActive":"bool","categoryId":"string","categoryName":"string","ownerUserId":"string","ownerUserName":"string"}
Get list of Catalogs
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","isActive":"bool","categoryId":"string","categoryName":"string","ownerUserId":"string","ownerUserName":"string"}]}
Get linked entities for Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export Catalog data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of Catalog data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of Catalog data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the Catalog stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the Catalog stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge Catalogs
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","isActive":"bool","categoryId":"string","categoryName":"string","ownerUserId":"string","ownerUserName":"string"}
Mass follow to Catalog entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from Catalog entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

Category

Get Category data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","categoryParentId":"string","categoryParentName":"string","categoryRoute":"string","categoryRouteName":"string","image":"string","scope":"string","hasChildren":"bool"}
Create Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","categoryParentId":"string","categoryParentName":"string","categoryRoute":"string","categoryRouteName":"string","image":"string","scope":"string","hasChildren":"bool"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","categoryParentId":"string","categoryParentName":"string","categoryRoute":"string","categoryRouteName":"string","image":"string","scope":"string","hasChildren":"bool"}
Edit Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","categoryParentId":"string","categoryParentName":"string","categoryRoute":"string","categoryRouteName":"string","image":"string","scope":"string","hasChildren":"bool"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","categoryParentId":"string","categoryParentName":"string","categoryRoute":"string","categoryRouteName":"string","image":"string","scope":"string","hasChildren":"bool"}
Get list of Categorys
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","categoryParentId":"string","categoryParentName":"string","categoryRoute":"string","categoryRouteName":"string","image":"string","scope":"string","hasChildren":"bool"}]}
Get linked entities for Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export Category data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of Category data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of Category data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the Category stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the Category stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge Categorys
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","code":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","categoryParentId":"string","categoryParentName":"string","categoryRoute":"string","categoryRouteName":"string","image":"string","scope":"string","hasChildren":"bool"}
Mass follow to Category entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from Category entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

CategoryImage

Get list of category image channels
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
categoryImageId string Category image id Yes
categoryId string Category id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
     'total': 'integer',
     'list': 'array'
 }
Update category image channels
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
categoryImageId string Category image id Yes
categoryId string Category id Yes
Body
'array'
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Update sort order
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
categoryId string Category id Yes
Body
{
     'ids': 'array'
 }
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Get CategoryImage data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","alt":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","image":"string","imagesMultiple":"string","type":"string","imageLink":"string","state":"string","size":"float","width":"integer","height":"integer","imageType":"string","scope":"string","sortOrder":"integer"}
Create CategoryImage
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","alt":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","image":"string","imagesMultiple":"string","type":"string","imageLink":"string","state":"string","size":"float","width":"integer","height":"integer","imageType":"string","scope":"string","sortOrder":"integer"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","alt":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","image":"string","imagesMultiple":"string","type":"string","imageLink":"string","state":"string","size":"float","width":"integer","height":"integer","imageType":"string","scope":"string","sortOrder":"integer"}
Edit CategoryImage
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","alt":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","image":"string","imagesMultiple":"string","type":"string","imageLink":"string","state":"string","size":"float","width":"integer","height":"integer","imageType":"string","scope":"string","sortOrder":"integer"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","alt":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","image":"string","imagesMultiple":"string","type":"string","imageLink":"string","state":"string","size":"float","width":"integer","height":"integer","imageType":"string","scope":"string","sortOrder":"integer"}
Get list of CategoryImages
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","alt":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","image":"string","imagesMultiple":"string","type":"string","imageLink":"string","state":"string","size":"float","width":"integer","height":"integer","imageType":"string","scope":"string","sortOrder":"integer"}]}
Get linked entities for CategoryImage
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete CategoryImage
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export CategoryImage data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of CategoryImage data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of CategoryImage data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for CategoryImage
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from CategoryImage
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the CategoryImage stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the CategoryImage stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge CategoryImages
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from CategoryImage
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","alt":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","image":"string","imagesMultiple":"string","type":"string","imageLink":"string","state":"string","size":"float","width":"integer","height":"integer","imageType":"string","scope":"string","sortOrder":"integer"}
Mass follow to CategoryImage entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from CategoryImage entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

Channel

Get channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'object'
Get list of channels
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
 'list': 'array',
 'total': 'int'
 }
Get channel product attributes
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
channel_id string Channel id Yes
product_id string Product id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
[{
 'productAttributeValueId': 'string',
 'attributeId': 'string',
 'name': 'string',
 'type': 'string',
 'isRequired': 'bool',
 'typeValue': [
   'string',
   'string',
   '...'
 ],
 'typeValueEnUs': [
   'string',
   'string',
   '...'
 ],
 'typeValue other languages ...': [],
 'value': 'array|string',
 'valueEnUs': 'array|string',
 'value other languages ...': 'array|string',
 'attributeGroupId': 'string',
 'attributeGroupName': 'string',
 'attributeGroupOrder': 'int',
 'isCustom': 'bool'
 }]
Get products in channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
channel_id string Channel id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
[{
     'channelProductId': 'string',
     'productId': 'string',
     'productName': 'string',
     'categories': [
          'string - categories name'
     ],
     'isActive': 'bool',
     'isEditable': 'bool'
},
     '...'
]

POST /Channel

Create Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","catalogId":"string","catalogName":"string","currencies":"string","locales":"string","code":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","catalogId":"string","catalogName":"string","currencies":"string","locales":"string","code":"string"}
Edit Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","catalogId":"string","catalogName":"string","currencies":"string","locales":"string","code":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","catalogId":"string","catalogName":"string","currencies":"string","locales":"string","code":"string"}
Get linked entities for Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export Channel data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of Channel data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of Channel data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the Channel stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the Channel stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge Channels
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","catalogId":"string","catalogName":"string","currencies":"string","locales":"string","code":"string"}
Mass follow to Channel entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from Channel entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

ChannelProductAttributeValue

Get ChannelProductAttributeValue data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"attributeId":"string","attributeName":"string","value":"string","valueDeDe":"string","valueEnUs":"string","channelId":"string","channelName":"string","productId":"string","productName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}
Create ChannelProductAttributeValue
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"attributeId":"string","attributeName":"string","value":"string","valueDeDe":"string","valueEnUs":"string","channelId":"string","channelName":"string","productId":"string","productName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"attributeId":"string","attributeName":"string","value":"string","valueDeDe":"string","valueEnUs":"string","channelId":"string","channelName":"string","productId":"string","productName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}
Edit ChannelProductAttributeValue
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"attributeId":"string","attributeName":"string","value":"string","valueDeDe":"string","valueEnUs":"string","channelId":"string","channelName":"string","productId":"string","productName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"attributeId":"string","attributeName":"string","value":"string","valueDeDe":"string","valueEnUs":"string","channelId":"string","channelName":"string","productId":"string","productName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}
Get list of ChannelProductAttributeValues
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"attributeId":"string","attributeName":"string","value":"string","valueDeDe":"string","valueEnUs":"string","channelId":"string","channelName":"string","productId":"string","productName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}]}
Get linked entities for ChannelProductAttributeValue
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete ChannelProductAttributeValue
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export ChannelProductAttributeValue data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of ChannelProductAttributeValue data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of ChannelProductAttributeValue data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for ChannelProductAttributeValue
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Remove link from ChannelProductAttributeValue
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Follow the ChannelProductAttributeValue stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Unfollow the ChannelProductAttributeValue stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'
Merge ChannelProductAttributeValues
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'attributes': 'json', 'targetId': 'string', 'sourceIds': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Get duplicate attributes from ChannelProductAttributeValue
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'id': 'string'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"attributeId":"string","attributeName":"string","value":"string","valueDeDe":"string","valueEnUs":"string","channelId":"string","channelName":"string","productId":"string","productName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string"}
Mass follow to ChannelProductAttributeValue entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}
Mass unfollow from ChannelProductAttributeValue entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{'ids':'array', 'count':'integer'}

Composer

Get git auth data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
     'username': 'test',
     'password': 'qwerty'
 }
Set git auth data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
     'username': 'test',
     'password': 'qwerty'
 }
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
1
Call composer update command
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'
Cancel changes
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
'bool'

Contact

Get Contact data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","salutationName":"string","firstName":"string","lastName":"string","accountId":"string","title":"string","description":"string","emailAddress":"string","phoneNumber":"string","doNotCall":"bool","address":"string","addressStreet":"string","addressCity":"string","addressState":"string","addressCountry":"string","addressPostalCode":"string","accountName":"string","accountRole":"string","accountIsInactive":"bool","accountType":"string","opportunityRole":"string","acceptanceStatus":"string","acceptanceStatusMeetings":"string","acceptanceStatusCalls":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","portalUserId":"string","portalUserName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","emailAddressIsOptedOut":"bool","addressMap":"string"}

POST /Contact

Create Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","salutationName":"string","firstName":"string","lastName":"string","accountId":"string","title":"string","description":"string","emailAddress":"string","phoneNumber":"string","doNotCall":"bool","address":"string","addressStreet":"string","addressCity":"string","addressState":"string","addressCountry":"string","addressPostalCode":"string","accountName":"string","accountRole":"string","accountIsInactive":"bool","accountType":"string","opportunityRole":"string","acceptanceStatus":"string","acceptanceStatusMeetings":"string","acceptanceStatusCalls":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","portalUserId":"string","portalUserName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","emailAddressIsOptedOut":"bool","addressMap":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","salutationName":"string","firstName":"string","lastName":"string","accountId":"string","title":"string","description":"string","emailAddress":"string","phoneNumber":"string","doNotCall":"bool","address":"string","addressStreet":"string","addressCity":"string","addressState":"string","addressCountry":"string","addressPostalCode":"string","accountName":"string","accountRole":"string","accountIsInactive":"bool","accountType":"string","opportunityRole":"string","acceptanceStatus":"string","acceptanceStatusMeetings":"string","acceptanceStatusCalls":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","portalUserId":"string","portalUserName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","emailAddressIsOptedOut":"bool","addressMap":"string"}
Edit Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","salutationName":"string","firstName":"string","lastName":"string","accountId":"string","title":"string","description":"string","emailAddress":"string","phoneNumber":"string","doNotCall":"bool","address":"string","addressStreet":"string","addressCity":"string","addressState":"string","addressCountry":"string","addressPostalCode":"string","accountName":"string","accountRole":"string","accountIsInactive":"bool","accountType":"string","opportunityRole":"string","acceptanceStatus":"string","acceptanceStatusMeetings":"string","acceptanceStatusCalls":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","portalUserId":"string","portalUserName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","emailAddressIsOptedOut":"bool","addressMap":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","salutationName":"string","firstName":"string","lastName":"string","accountId":"string","title":"string","description":"string","emailAddress":"string","phoneNumber":"string","doNotCall":"bool","address":"string","addressStreet":"string","addressCity":"string","addressState":"string","addressCountry":"string","addressPostalCode":"string","accountName":"string","accountRole":"string","accountIsInactive":"bool","accountType":"string","opportunityRole":"string","acceptanceStatus":"string","acceptanceStatusMeetings":"string","acceptanceStatusCalls":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","portalUserId":"string","portalUserName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","emailAddressIsOptedOut":"bool","addressMap":"string"}
Get list of Contacts
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"total":"int","list": [{"id":"string","deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","salutationName":"string","firstName":"string","lastName":"string","accountId":"string","title":"string","description":"string","emailAddress":"string","phoneNumber":"string","doNotCall":"bool","address":"string","addressStreet":"string","addressCity":"string","addressState":"string","addressCountry":"string","addressPostalCode":"string","accountName":"string","accountRole":"string","accountIsInactive":"bool","accountType":"string","opportunityRole":"string","acceptanceStatus":"string","acceptanceStatusMeetings":"string","acceptanceStatusCalls":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","portalUserId":"string","portalUserName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","emailAddressIsOptedOut":"bool","addressMap":"string"}]}
Get linked entities for Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'total':'integer', 'list': 'array'}
Delete Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Export Contact data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'id': 'string'}
Mass update of Contact data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{'attributes': 'json', 'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Mass delete of Contact data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{'ids': 'array'}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{'count':'integer', 'ids':'array'}
Create link for Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{'ids': 'array'}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
'bool'

DELETE