POST api/Common/SyncAddressBook
Request Information
URI Parameters
None.
Body Parameters
AgentSubscription| Name | Description | Type | Additional information |
|---|---|---|---|
| AgentSubscriptionID | integer |
None. |
|
| ProviderID | integer |
None. |
|
| AgentID | integer |
None. |
|
| UserID | string |
None. |
|
| Password | string |
None. |
|
| APIKey | string |
None. |
|
| AccountID | string |
None. |
|
| OptionalField2 | string |
None. |
|
| OptionalField3 | string |
None. |
|
| OptionalField4 | string |
None. |
|
| Status | boolean |
None. |
|
| CreatedBy | integer |
None. |
|
| CreatedDate | date |
None. |
|
| ModifiedBy | integer |
None. |
|
| ModifiedDate | date |
None. |
|
| Agent | Agent |
None. |
|
| AgentList | Collection of Agent |
None. |
|
| SelectedProviders | Collection of AgentSubscription |
None. |
|
| AddressSyncGroup | Collection of AddressSyncGroup |
None. |
|
| AddressBook | Collection of ShopperDetailsViewModel |
None. |
|
| ListID | string |
None. |
|
| ListName | string |
None. |
|
| AgentDllName | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| string |
None. |
||
| IsFromStoreFront | boolean |
None. |
Request Formats
application/json, text/json, text/html
Sample:
{
"AgentSubscriptionID": 1,
"ProviderID": 2,
"AgentID": 3,
"UserID": "sample string 4",
"Password": "sample string 5",
"APIKey": "sample string 6",
"AccountID": "sample string 7",
"OptionalField2": "sample string 8",
"OptionalField3": "sample string 9",
"OptionalField4": "sample string 10",
"Status": true,
"CreatedBy": 12,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"Agent": {
"AgentID": 1,
"Name": "sample string 2",
"AgentDLLName": "sample string 3",
"AgentTypeID": 64,
"Status": true,
"CreatedBy": 6,
"AppID": 1,
"CreatedDate": "1/22/2025",
"ModifiedBy": "sample string 8",
"ModifiedDate": "1/22/2025",
"AgentSubscriptions": [],
"EventSubscriptions": [
{
"EventSubscriptionID": 1,
"ProviderID": 2,
"EventID": 3,
"AgentID": 4,
"FromAddress": "sample string 5",
"CCList": "sample string 6",
"CustomSubject": "sample string 7",
"Status": true,
"CreatedBy": 9,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"Event": {
"ProviderID": 1,
"EventName": "sample string 2",
"Status": true,
"Display": true,
"CreatedBy": 5,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"PlaceholdersList": "sample string 7",
"ModifiedDate": "1/22/2025",
"EventSubscriptions": [],
"EventTemplates": [
{
"EventTemplateID": 1,
"EventID": 2,
"TemplateName": "sample string 3",
"TemplateImage": "sample string 4",
"ProviderID": 5,
"Subject": "sample string 6",
"Body": "sample string 7",
"Default": true,
"Deleted": true,
"Status": true,
"CreatedBy": 11,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"CommunicationTypeID": 64,
"SMSBody": "sample string 14",
"CustomEmailCSS": "sample string 15",
"GroupFromEmail": "sample string 16",
"GroupCCList": "sample string 17",
"GroupStores": "sample string 18",
"CCList": "sample string 19",
"DefaultCount": 20
},
{
"EventTemplateID": 1,
"EventID": 2,
"TemplateName": "sample string 3",
"TemplateImage": "sample string 4",
"ProviderID": 5,
"Subject": "sample string 6",
"Body": "sample string 7",
"Default": true,
"Deleted": true,
"Status": true,
"CreatedBy": 11,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"CommunicationTypeID": 64,
"SMSBody": "sample string 14",
"CustomEmailCSS": "sample string 15",
"GroupFromEmail": "sample string 16",
"GroupCCList": "sample string 17",
"GroupStores": "sample string 18",
"CCList": "sample string 19",
"DefaultCount": 20
}
],
"OutboundMessages": [
{
"OutboundMessageID": 1,
"ProviderID": 2,
"InboundMessageID": 3,
"CommunicationTypeID": 64,
"FromAddress": "sample string 5",
"ToList": "sample string 6",
"CCList": "sample string 7",
"Subject": "sample string 8",
"MessageBody": "sample string 9",
"Placeholders": "sample string 10",
"PlaceholderValues": "sample string 11",
"AgentDLLName": "sample string 12",
"AgentUserID": "sample string 13",
"AgentPassword": "sample string 14",
"OptionalField1": "sample string 15",
"OptionalField2": "sample string 16",
"OptionalField3": "sample string 17",
"OptionalField4": "sample string 18",
"ExceptionMessage": "sample string 19",
"Status": 64,
"MessageCreatedDate": "1/22/2025",
"MessageSentDate": "1/22/2025",
"Attachments": "sample string 22",
"AgentName": "sample string 23",
"ToContactNumber": "sample string 24",
"SMSBody": "sample string 25",
"AgentAPIKey": "sample string 26",
"CurrencyCode": "sample string 27",
"CustomEmailCSS": "sample string 28",
"AttachHasFilePath": true,
"ApprovalOrderID": 1
},
{
"OutboundMessageID": 1,
"ProviderID": 2,
"InboundMessageID": 3,
"CommunicationTypeID": 64,
"FromAddress": "sample string 5",
"ToList": "sample string 6",
"CCList": "sample string 7",
"Subject": "sample string 8",
"MessageBody": "sample string 9",
"Placeholders": "sample string 10",
"PlaceholderValues": "sample string 11",
"AgentDLLName": "sample string 12",
"AgentUserID": "sample string 13",
"AgentPassword": "sample string 14",
"OptionalField1": "sample string 15",
"OptionalField2": "sample string 16",
"OptionalField3": "sample string 17",
"OptionalField4": "sample string 18",
"ExceptionMessage": "sample string 19",
"Status": 64,
"MessageCreatedDate": "1/22/2025",
"MessageSentDate": "1/22/2025",
"Attachments": "sample string 22",
"AgentName": "sample string 23",
"ToContactNumber": "sample string 24",
"SMSBody": "sample string 25",
"AgentAPIKey": "sample string 26",
"CurrencyCode": "sample string 27",
"CustomEmailCSS": "sample string 28",
"AttachHasFilePath": true,
"ApprovalOrderID": 1
}
],
"InboundMessages": [
{
"InboundMessageID": 1,
"EventID": 2,
"ProviderID": 3,
"ToList": "sample string 4",
"PlaceholderValues": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "1/22/2025",
"CCList": "sample string 8",
"ToContactNumber": "sample string 9",
"CurrencyCode": "sample string 10",
"AttachHasFilePath": true,
"ApprovalOrderID": 1,
"GroupStoreID": 12
},
{
"InboundMessageID": 1,
"EventID": 2,
"ProviderID": 3,
"ToList": "sample string 4",
"PlaceholderValues": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "1/22/2025",
"CCList": "sample string 8",
"ToContactNumber": "sample string 9",
"CurrencyCode": "sample string 10",
"AttachHasFilePath": true,
"ApprovalOrderID": 1,
"GroupStoreID": 12
}
],
"Id": 8
},
"CommunicationTypeID": 64
},
{
"EventSubscriptionID": 1,
"ProviderID": 2,
"EventID": 3,
"AgentID": 4,
"FromAddress": "sample string 5",
"CCList": "sample string 6",
"CustomSubject": "sample string 7",
"Status": true,
"CreatedBy": 9,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"Event": {
"ProviderID": 1,
"EventName": "sample string 2",
"Status": true,
"Display": true,
"CreatedBy": 5,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"PlaceholdersList": "sample string 7",
"ModifiedDate": "1/22/2025",
"EventSubscriptions": [],
"EventTemplates": [
{
"EventTemplateID": 1,
"EventID": 2,
"TemplateName": "sample string 3",
"TemplateImage": "sample string 4",
"ProviderID": 5,
"Subject": "sample string 6",
"Body": "sample string 7",
"Default": true,
"Deleted": true,
"Status": true,
"CreatedBy": 11,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"CommunicationTypeID": 64,
"SMSBody": "sample string 14",
"CustomEmailCSS": "sample string 15",
"GroupFromEmail": "sample string 16",
"GroupCCList": "sample string 17",
"GroupStores": "sample string 18",
"CCList": "sample string 19",
"DefaultCount": 20
},
{
"EventTemplateID": 1,
"EventID": 2,
"TemplateName": "sample string 3",
"TemplateImage": "sample string 4",
"ProviderID": 5,
"Subject": "sample string 6",
"Body": "sample string 7",
"Default": true,
"Deleted": true,
"Status": true,
"CreatedBy": 11,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"CommunicationTypeID": 64,
"SMSBody": "sample string 14",
"CustomEmailCSS": "sample string 15",
"GroupFromEmail": "sample string 16",
"GroupCCList": "sample string 17",
"GroupStores": "sample string 18",
"CCList": "sample string 19",
"DefaultCount": 20
}
],
"OutboundMessages": [
{
"OutboundMessageID": 1,
"ProviderID": 2,
"InboundMessageID": 3,
"CommunicationTypeID": 64,
"FromAddress": "sample string 5",
"ToList": "sample string 6",
"CCList": "sample string 7",
"Subject": "sample string 8",
"MessageBody": "sample string 9",
"Placeholders": "sample string 10",
"PlaceholderValues": "sample string 11",
"AgentDLLName": "sample string 12",
"AgentUserID": "sample string 13",
"AgentPassword": "sample string 14",
"OptionalField1": "sample string 15",
"OptionalField2": "sample string 16",
"OptionalField3": "sample string 17",
"OptionalField4": "sample string 18",
"ExceptionMessage": "sample string 19",
"Status": 64,
"MessageCreatedDate": "1/22/2025",
"MessageSentDate": "1/22/2025",
"Attachments": "sample string 22",
"AgentName": "sample string 23",
"ToContactNumber": "sample string 24",
"SMSBody": "sample string 25",
"AgentAPIKey": "sample string 26",
"CurrencyCode": "sample string 27",
"CustomEmailCSS": "sample string 28",
"AttachHasFilePath": true,
"ApprovalOrderID": 1
},
{
"OutboundMessageID": 1,
"ProviderID": 2,
"InboundMessageID": 3,
"CommunicationTypeID": 64,
"FromAddress": "sample string 5",
"ToList": "sample string 6",
"CCList": "sample string 7",
"Subject": "sample string 8",
"MessageBody": "sample string 9",
"Placeholders": "sample string 10",
"PlaceholderValues": "sample string 11",
"AgentDLLName": "sample string 12",
"AgentUserID": "sample string 13",
"AgentPassword": "sample string 14",
"OptionalField1": "sample string 15",
"OptionalField2": "sample string 16",
"OptionalField3": "sample string 17",
"OptionalField4": "sample string 18",
"ExceptionMessage": "sample string 19",
"Status": 64,
"MessageCreatedDate": "1/22/2025",
"MessageSentDate": "1/22/2025",
"Attachments": "sample string 22",
"AgentName": "sample string 23",
"ToContactNumber": "sample string 24",
"SMSBody": "sample string 25",
"AgentAPIKey": "sample string 26",
"CurrencyCode": "sample string 27",
"CustomEmailCSS": "sample string 28",
"AttachHasFilePath": true,
"ApprovalOrderID": 1
}
],
"InboundMessages": [
{
"InboundMessageID": 1,
"EventID": 2,
"ProviderID": 3,
"ToList": "sample string 4",
"PlaceholderValues": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "1/22/2025",
"CCList": "sample string 8",
"ToContactNumber": "sample string 9",
"CurrencyCode": "sample string 10",
"AttachHasFilePath": true,
"ApprovalOrderID": 1,
"GroupStoreID": 12
},
{
"InboundMessageID": 1,
"EventID": 2,
"ProviderID": 3,
"ToList": "sample string 4",
"PlaceholderValues": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "1/22/2025",
"CCList": "sample string 8",
"ToContactNumber": "sample string 9",
"CurrencyCode": "sample string 10",
"AttachHasFilePath": true,
"ApprovalOrderID": 1,
"GroupStoreID": 12
}
],
"Id": 8
},
"CommunicationTypeID": 64
}
],
"SCExclusive": true,
"Display": true
},
"AgentList": [
{
"AgentID": 1,
"Name": "sample string 2",
"AgentDLLName": "sample string 3",
"AgentTypeID": 64,
"Status": true,
"CreatedBy": 6,
"AppID": 1,
"CreatedDate": "1/22/2025",
"ModifiedBy": "sample string 8",
"ModifiedDate": "1/22/2025",
"AgentSubscriptions": [],
"EventSubscriptions": [
{
"EventSubscriptionID": 1,
"ProviderID": 2,
"EventID": 3,
"AgentID": 4,
"FromAddress": "sample string 5",
"CCList": "sample string 6",
"CustomSubject": "sample string 7",
"Status": true,
"CreatedBy": 9,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"Event": {
"ProviderID": 1,
"EventName": "sample string 2",
"Status": true,
"Display": true,
"CreatedBy": 5,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"PlaceholdersList": "sample string 7",
"ModifiedDate": "1/22/2025",
"EventSubscriptions": [],
"EventTemplates": [
{
"EventTemplateID": 1,
"EventID": 2,
"TemplateName": "sample string 3",
"TemplateImage": "sample string 4",
"ProviderID": 5,
"Subject": "sample string 6",
"Body": "sample string 7",
"Default": true,
"Deleted": true,
"Status": true,
"CreatedBy": 11,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"CommunicationTypeID": 64,
"SMSBody": "sample string 14",
"CustomEmailCSS": "sample string 15",
"GroupFromEmail": "sample string 16",
"GroupCCList": "sample string 17",
"GroupStores": "sample string 18",
"CCList": "sample string 19",
"DefaultCount": 20
},
{
"EventTemplateID": 1,
"EventID": 2,
"TemplateName": "sample string 3",
"TemplateImage": "sample string 4",
"ProviderID": 5,
"Subject": "sample string 6",
"Body": "sample string 7",
"Default": true,
"Deleted": true,
"Status": true,
"CreatedBy": 11,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"CommunicationTypeID": 64,
"SMSBody": "sample string 14",
"CustomEmailCSS": "sample string 15",
"GroupFromEmail": "sample string 16",
"GroupCCList": "sample string 17",
"GroupStores": "sample string 18",
"CCList": "sample string 19",
"DefaultCount": 20
}
],
"OutboundMessages": [
{
"OutboundMessageID": 1,
"ProviderID": 2,
"InboundMessageID": 3,
"CommunicationTypeID": 64,
"FromAddress": "sample string 5",
"ToList": "sample string 6",
"CCList": "sample string 7",
"Subject": "sample string 8",
"MessageBody": "sample string 9",
"Placeholders": "sample string 10",
"PlaceholderValues": "sample string 11",
"AgentDLLName": "sample string 12",
"AgentUserID": "sample string 13",
"AgentPassword": "sample string 14",
"OptionalField1": "sample string 15",
"OptionalField2": "sample string 16",
"OptionalField3": "sample string 17",
"OptionalField4": "sample string 18",
"ExceptionMessage": "sample string 19",
"Status": 64,
"MessageCreatedDate": "1/22/2025",
"MessageSentDate": "1/22/2025",
"Attachments": "sample string 22",
"AgentName": "sample string 23",
"ToContactNumber": "sample string 24",
"SMSBody": "sample string 25",
"AgentAPIKey": "sample string 26",
"CurrencyCode": "sample string 27",
"CustomEmailCSS": "sample string 28",
"AttachHasFilePath": true,
"ApprovalOrderID": 1
},
{
"OutboundMessageID": 1,
"ProviderID": 2,
"InboundMessageID": 3,
"CommunicationTypeID": 64,
"FromAddress": "sample string 5",
"ToList": "sample string 6",
"CCList": "sample string 7",
"Subject": "sample string 8",
"MessageBody": "sample string 9",
"Placeholders": "sample string 10",
"PlaceholderValues": "sample string 11",
"AgentDLLName": "sample string 12",
"AgentUserID": "sample string 13",
"AgentPassword": "sample string 14",
"OptionalField1": "sample string 15",
"OptionalField2": "sample string 16",
"OptionalField3": "sample string 17",
"OptionalField4": "sample string 18",
"ExceptionMessage": "sample string 19",
"Status": 64,
"MessageCreatedDate": "1/22/2025",
"MessageSentDate": "1/22/2025",
"Attachments": "sample string 22",
"AgentName": "sample string 23",
"ToContactNumber": "sample string 24",
"SMSBody": "sample string 25",
"AgentAPIKey": "sample string 26",
"CurrencyCode": "sample string 27",
"CustomEmailCSS": "sample string 28",
"AttachHasFilePath": true,
"ApprovalOrderID": 1
}
],
"InboundMessages": [
{
"InboundMessageID": 1,
"EventID": 2,
"ProviderID": 3,
"ToList": "sample string 4",
"PlaceholderValues": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "1/22/2025",
"CCList": "sample string 8",
"ToContactNumber": "sample string 9",
"CurrencyCode": "sample string 10",
"AttachHasFilePath": true,
"ApprovalOrderID": 1,
"GroupStoreID": 12
},
{
"InboundMessageID": 1,
"EventID": 2,
"ProviderID": 3,
"ToList": "sample string 4",
"PlaceholderValues": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "1/22/2025",
"CCList": "sample string 8",
"ToContactNumber": "sample string 9",
"CurrencyCode": "sample string 10",
"AttachHasFilePath": true,
"ApprovalOrderID": 1,
"GroupStoreID": 12
}
],
"Id": 8
},
"CommunicationTypeID": 64
},
{
"EventSubscriptionID": 1,
"ProviderID": 2,
"EventID": 3,
"AgentID": 4,
"FromAddress": "sample string 5",
"CCList": "sample string 6",
"CustomSubject": "sample string 7",
"Status": true,
"CreatedBy": 9,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"Event": {
"ProviderID": 1,
"EventName": "sample string 2",
"Status": true,
"Display": true,
"CreatedBy": 5,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"PlaceholdersList": "sample string 7",
"ModifiedDate": "1/22/2025",
"EventSubscriptions": [],
"EventTemplates": [
{
"EventTemplateID": 1,
"EventID": 2,
"TemplateName": "sample string 3",
"TemplateImage": "sample string 4",
"ProviderID": 5,
"Subject": "sample string 6",
"Body": "sample string 7",
"Default": true,
"Deleted": true,
"Status": true,
"CreatedBy": 11,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"CommunicationTypeID": 64,
"SMSBody": "sample string 14",
"CustomEmailCSS": "sample string 15",
"GroupFromEmail": "sample string 16",
"GroupCCList": "sample string 17",
"GroupStores": "sample string 18",
"CCList": "sample string 19",
"DefaultCount": 20
},
{
"EventTemplateID": 1,
"EventID": 2,
"TemplateName": "sample string 3",
"TemplateImage": "sample string 4",
"ProviderID": 5,
"Subject": "sample string 6",
"Body": "sample string 7",
"Default": true,
"Deleted": true,
"Status": true,
"CreatedBy": 11,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"CommunicationTypeID": 64,
"SMSBody": "sample string 14",
"CustomEmailCSS": "sample string 15",
"GroupFromEmail": "sample string 16",
"GroupCCList": "sample string 17",
"GroupStores": "sample string 18",
"CCList": "sample string 19",
"DefaultCount": 20
}
],
"OutboundMessages": [
{
"OutboundMessageID": 1,
"ProviderID": 2,
"InboundMessageID": 3,
"CommunicationTypeID": 64,
"FromAddress": "sample string 5",
"ToList": "sample string 6",
"CCList": "sample string 7",
"Subject": "sample string 8",
"MessageBody": "sample string 9",
"Placeholders": "sample string 10",
"PlaceholderValues": "sample string 11",
"AgentDLLName": "sample string 12",
"AgentUserID": "sample string 13",
"AgentPassword": "sample string 14",
"OptionalField1": "sample string 15",
"OptionalField2": "sample string 16",
"OptionalField3": "sample string 17",
"OptionalField4": "sample string 18",
"ExceptionMessage": "sample string 19",
"Status": 64,
"MessageCreatedDate": "1/22/2025",
"MessageSentDate": "1/22/2025",
"Attachments": "sample string 22",
"AgentName": "sample string 23",
"ToContactNumber": "sample string 24",
"SMSBody": "sample string 25",
"AgentAPIKey": "sample string 26",
"CurrencyCode": "sample string 27",
"CustomEmailCSS": "sample string 28",
"AttachHasFilePath": true,
"ApprovalOrderID": 1
},
{
"OutboundMessageID": 1,
"ProviderID": 2,
"InboundMessageID": 3,
"CommunicationTypeID": 64,
"FromAddress": "sample string 5",
"ToList": "sample string 6",
"CCList": "sample string 7",
"Subject": "sample string 8",
"MessageBody": "sample string 9",
"Placeholders": "sample string 10",
"PlaceholderValues": "sample string 11",
"AgentDLLName": "sample string 12",
"AgentUserID": "sample string 13",
"AgentPassword": "sample string 14",
"OptionalField1": "sample string 15",
"OptionalField2": "sample string 16",
"OptionalField3": "sample string 17",
"OptionalField4": "sample string 18",
"ExceptionMessage": "sample string 19",
"Status": 64,
"MessageCreatedDate": "1/22/2025",
"MessageSentDate": "1/22/2025",
"Attachments": "sample string 22",
"AgentName": "sample string 23",
"ToContactNumber": "sample string 24",
"SMSBody": "sample string 25",
"AgentAPIKey": "sample string 26",
"CurrencyCode": "sample string 27",
"CustomEmailCSS": "sample string 28",
"AttachHasFilePath": true,
"ApprovalOrderID": 1
}
],
"InboundMessages": [
{
"InboundMessageID": 1,
"EventID": 2,
"ProviderID": 3,
"ToList": "sample string 4",
"PlaceholderValues": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "1/22/2025",
"CCList": "sample string 8",
"ToContactNumber": "sample string 9",
"CurrencyCode": "sample string 10",
"AttachHasFilePath": true,
"ApprovalOrderID": 1,
"GroupStoreID": 12
},
{
"InboundMessageID": 1,
"EventID": 2,
"ProviderID": 3,
"ToList": "sample string 4",
"PlaceholderValues": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "1/22/2025",
"CCList": "sample string 8",
"ToContactNumber": "sample string 9",
"CurrencyCode": "sample string 10",
"AttachHasFilePath": true,
"ApprovalOrderID": 1,
"GroupStoreID": 12
}
],
"Id": 8
},
"CommunicationTypeID": 64
}
],
"SCExclusive": true,
"Display": true
},
{
"AgentID": 1,
"Name": "sample string 2",
"AgentDLLName": "sample string 3",
"AgentTypeID": 64,
"Status": true,
"CreatedBy": 6,
"AppID": 1,
"CreatedDate": "1/22/2025",
"ModifiedBy": "sample string 8",
"ModifiedDate": "1/22/2025",
"AgentSubscriptions": [],
"EventSubscriptions": [
{
"EventSubscriptionID": 1,
"ProviderID": 2,
"EventID": 3,
"AgentID": 4,
"FromAddress": "sample string 5",
"CCList": "sample string 6",
"CustomSubject": "sample string 7",
"Status": true,
"CreatedBy": 9,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"Event": {
"ProviderID": 1,
"EventName": "sample string 2",
"Status": true,
"Display": true,
"CreatedBy": 5,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"PlaceholdersList": "sample string 7",
"ModifiedDate": "1/22/2025",
"EventSubscriptions": [],
"EventTemplates": [
{
"EventTemplateID": 1,
"EventID": 2,
"TemplateName": "sample string 3",
"TemplateImage": "sample string 4",
"ProviderID": 5,
"Subject": "sample string 6",
"Body": "sample string 7",
"Default": true,
"Deleted": true,
"Status": true,
"CreatedBy": 11,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"CommunicationTypeID": 64,
"SMSBody": "sample string 14",
"CustomEmailCSS": "sample string 15",
"GroupFromEmail": "sample string 16",
"GroupCCList": "sample string 17",
"GroupStores": "sample string 18",
"CCList": "sample string 19",
"DefaultCount": 20
},
{
"EventTemplateID": 1,
"EventID": 2,
"TemplateName": "sample string 3",
"TemplateImage": "sample string 4",
"ProviderID": 5,
"Subject": "sample string 6",
"Body": "sample string 7",
"Default": true,
"Deleted": true,
"Status": true,
"CreatedBy": 11,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"CommunicationTypeID": 64,
"SMSBody": "sample string 14",
"CustomEmailCSS": "sample string 15",
"GroupFromEmail": "sample string 16",
"GroupCCList": "sample string 17",
"GroupStores": "sample string 18",
"CCList": "sample string 19",
"DefaultCount": 20
}
],
"OutboundMessages": [
{
"OutboundMessageID": 1,
"ProviderID": 2,
"InboundMessageID": 3,
"CommunicationTypeID": 64,
"FromAddress": "sample string 5",
"ToList": "sample string 6",
"CCList": "sample string 7",
"Subject": "sample string 8",
"MessageBody": "sample string 9",
"Placeholders": "sample string 10",
"PlaceholderValues": "sample string 11",
"AgentDLLName": "sample string 12",
"AgentUserID": "sample string 13",
"AgentPassword": "sample string 14",
"OptionalField1": "sample string 15",
"OptionalField2": "sample string 16",
"OptionalField3": "sample string 17",
"OptionalField4": "sample string 18",
"ExceptionMessage": "sample string 19",
"Status": 64,
"MessageCreatedDate": "1/22/2025",
"MessageSentDate": "1/22/2025",
"Attachments": "sample string 22",
"AgentName": "sample string 23",
"ToContactNumber": "sample string 24",
"SMSBody": "sample string 25",
"AgentAPIKey": "sample string 26",
"CurrencyCode": "sample string 27",
"CustomEmailCSS": "sample string 28",
"AttachHasFilePath": true,
"ApprovalOrderID": 1
},
{
"OutboundMessageID": 1,
"ProviderID": 2,
"InboundMessageID": 3,
"CommunicationTypeID": 64,
"FromAddress": "sample string 5",
"ToList": "sample string 6",
"CCList": "sample string 7",
"Subject": "sample string 8",
"MessageBody": "sample string 9",
"Placeholders": "sample string 10",
"PlaceholderValues": "sample string 11",
"AgentDLLName": "sample string 12",
"AgentUserID": "sample string 13",
"AgentPassword": "sample string 14",
"OptionalField1": "sample string 15",
"OptionalField2": "sample string 16",
"OptionalField3": "sample string 17",
"OptionalField4": "sample string 18",
"ExceptionMessage": "sample string 19",
"Status": 64,
"MessageCreatedDate": "1/22/2025",
"MessageSentDate": "1/22/2025",
"Attachments": "sample string 22",
"AgentName": "sample string 23",
"ToContactNumber": "sample string 24",
"SMSBody": "sample string 25",
"AgentAPIKey": "sample string 26",
"CurrencyCode": "sample string 27",
"CustomEmailCSS": "sample string 28",
"AttachHasFilePath": true,
"ApprovalOrderID": 1
}
],
"InboundMessages": [
{
"InboundMessageID": 1,
"EventID": 2,
"ProviderID": 3,
"ToList": "sample string 4",
"PlaceholderValues": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "1/22/2025",
"CCList": "sample string 8",
"ToContactNumber": "sample string 9",
"CurrencyCode": "sample string 10",
"AttachHasFilePath": true,
"ApprovalOrderID": 1,
"GroupStoreID": 12
},
{
"InboundMessageID": 1,
"EventID": 2,
"ProviderID": 3,
"ToList": "sample string 4",
"PlaceholderValues": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "1/22/2025",
"CCList": "sample string 8",
"ToContactNumber": "sample string 9",
"CurrencyCode": "sample string 10",
"AttachHasFilePath": true,
"ApprovalOrderID": 1,
"GroupStoreID": 12
}
],
"Id": 8
},
"CommunicationTypeID": 64
},
{
"EventSubscriptionID": 1,
"ProviderID": 2,
"EventID": 3,
"AgentID": 4,
"FromAddress": "sample string 5",
"CCList": "sample string 6",
"CustomSubject": "sample string 7",
"Status": true,
"CreatedBy": 9,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"Event": {
"ProviderID": 1,
"EventName": "sample string 2",
"Status": true,
"Display": true,
"CreatedBy": 5,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"PlaceholdersList": "sample string 7",
"ModifiedDate": "1/22/2025",
"EventSubscriptions": [],
"EventTemplates": [
{
"EventTemplateID": 1,
"EventID": 2,
"TemplateName": "sample string 3",
"TemplateImage": "sample string 4",
"ProviderID": 5,
"Subject": "sample string 6",
"Body": "sample string 7",
"Default": true,
"Deleted": true,
"Status": true,
"CreatedBy": 11,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"CommunicationTypeID": 64,
"SMSBody": "sample string 14",
"CustomEmailCSS": "sample string 15",
"GroupFromEmail": "sample string 16",
"GroupCCList": "sample string 17",
"GroupStores": "sample string 18",
"CCList": "sample string 19",
"DefaultCount": 20
},
{
"EventTemplateID": 1,
"EventID": 2,
"TemplateName": "sample string 3",
"TemplateImage": "sample string 4",
"ProviderID": 5,
"Subject": "sample string 6",
"Body": "sample string 7",
"Default": true,
"Deleted": true,
"Status": true,
"CreatedBy": 11,
"CreatedDate": "1/22/2025",
"ModifiedBy": 1,
"ModifiedDate": "1/22/2025",
"CommunicationTypeID": 64,
"SMSBody": "sample string 14",
"CustomEmailCSS": "sample string 15",
"GroupFromEmail": "sample string 16",
"GroupCCList": "sample string 17",
"GroupStores": "sample string 18",
"CCList": "sample string 19",
"DefaultCount": 20
}
],
"OutboundMessages": [
{
"OutboundMessageID": 1,
"ProviderID": 2,
"InboundMessageID": 3,
"CommunicationTypeID": 64,
"FromAddress": "sample string 5",
"ToList": "sample string 6",
"CCList": "sample string 7",
"Subject": "sample string 8",
"MessageBody": "sample string 9",
"Placeholders": "sample string 10",
"PlaceholderValues": "sample string 11",
"AgentDLLName": "sample string 12",
"AgentUserID": "sample string 13",
"AgentPassword": "sample string 14",
"OptionalField1": "sample string 15",
"OptionalField2": "sample string 16",
"OptionalField3": "sample string 17",
"OptionalField4": "sample string 18",
"ExceptionMessage": "sample string 19",
"Status": 64,
"MessageCreatedDate": "1/22/2025",
"MessageSentDate": "1/22/2025",
"Attachments": "sample string 22",
"AgentName": "sample string 23",
"ToContactNumber": "sample string 24",
"SMSBody": "sample string 25",
"AgentAPIKey": "sample string 26",
"CurrencyCode": "sample string 27",
"CustomEmailCSS": "sample string 28",
"AttachHasFilePath": true,
"ApprovalOrderID": 1
},
{
"OutboundMessageID": 1,
"ProviderID": 2,
"InboundMessageID": 3,
"CommunicationTypeID": 64,
"FromAddress": "sample string 5",
"ToList": "sample string 6",
"CCList": "sample string 7",
"Subject": "sample string 8",
"MessageBody": "sample string 9",
"Placeholders": "sample string 10",
"PlaceholderValues": "sample string 11",
"AgentDLLName": "sample string 12",
"AgentUserID": "sample string 13",
"AgentPassword": "sample string 14",
"OptionalField1": "sample string 15",
"OptionalField2": "sample string 16",
"OptionalField3": "sample string 17",
"OptionalField4": "sample string 18",
"ExceptionMessage": "sample string 19",
"Status": 64,
"MessageCreatedDate": "1/22/2025",
"MessageSentDate": "1/22/2025",
"Attachments": "sample string 22",
"AgentName": "sample string 23",
"ToContactNumber": "sample string 24",
"SMSBody": "sample string 25",
"AgentAPIKey": "sample string 26",
"CurrencyCode": "sample string 27",
"CustomEmailCSS": "sample string 28",
"AttachHasFilePath": true,
"ApprovalOrderID": 1
}
],
"InboundMessages": [
{
"InboundMessageID": 1,
"EventID": 2,
"ProviderID": 3,
"ToList": "sample string 4",
"PlaceholderValues": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "1/22/2025",
"CCList": "sample string 8",
"ToContactNumber": "sample string 9",
"CurrencyCode": "sample string 10",
"AttachHasFilePath": true,
"ApprovalOrderID": 1,
"GroupStoreID": 12
},
{
"InboundMessageID": 1,
"EventID": 2,
"ProviderID": 3,
"ToList": "sample string 4",
"PlaceholderValues": "sample string 5",
"CreatedBy": 6,
"CreatedDate": "1/22/2025",
"CCList": "sample string 8",
"ToContactNumber": "sample string 9",
"CurrencyCode": "sample string 10",
"AttachHasFilePath": true,
"ApprovalOrderID": 1,
"GroupStoreID": 12
}
],
"Id": 8
},
"CommunicationTypeID": 64
}
],
"SCExclusive": true,
"Display": true
}
],
"SelectedProviders": [],
"AddressSyncGroup": [
{
"ListID": 1,
"ListName": "sample string 2"
},
{
"ListID": 1,
"ListName": "sample string 2"
}
],
"AddressBook": [
{
"FullName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4",
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"City": "sample string 7",
"State": "sample string 8",
"Country": "sample string 9",
"ZipCode": "sample string 10",
"PhoneNumber": "sample string 11"
},
{
"FullName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4",
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"City": "sample string 7",
"State": "sample string 8",
"Country": "sample string 9",
"ZipCode": "sample string 10",
"PhoneNumber": "sample string 11"
}
],
"ListID": "sample string 14",
"ListName": "sample string 15",
"AgentDllName": "sample string 16",
"FirstName": "sample string 17",
"LastName": "sample string 18",
"Email": "sample string 19",
"IsFromStoreFront": true
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
integerResponse Formats
application/json, text/json, text/html
Sample:
1
application/xml, text/xml
Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>