| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SuiteDataSourceInstanceId | query | Guid | Yes | Guid representing the external systems datasource information. |
| AlternateKey | query | string | Yes | The unique key that represents the contact group on the external system. |
| ObjectId | query | Guid | No | Guid of the contact group object within Eros. If ObjectId is known, the external system may pass this insted of the alternate key. |
| IgnoreHash | query | bool | No | If set to true, the object will be updated/refreshed. If false, the hash representation of the ContactGroup model and its data will be compared with the current ContactGroup to determine if there are any changes to save. |
| ContactGroup | query | SubscriptionContactGroupModel | Yes | Object containing all details of the contact group to be inserted or updated. |
| IgnoreValidation | query | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ValidationErrors | form | List<RuleValidationResult> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RuleCode | form | string | No | |
| Message | form | string | No | |
| Key | form | string | No | |
| Tag | form | string | No | |
| ErrorCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactGroupName | query | string | Yes | A name for the contact group. |
| GroupRoleId | query | Guid | Yes | Guid of the Role List Item object within Eros that defines the role of the group. |
| RoleAlternateKey | query | string | No | The unique key that represents the role type of the group on the external system. Note: Use of this is not currently implemented |
| ContactConnections | query | List<SubscriptionContactGroupConnectionModel> | No | A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group. |
| MarkAsDeleted | query | bool | No | Set this to be true if the contact group is to be deleted |
| MarkAsArchived | query | bool | No | Set this to be true if the contact group is to be archived |
| MarkAsRestored | query | bool | No | Set this to be true if the contact group is to be restored |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Index | query | int | No | The order this contact is in priority. 1 would be the primary contact, 2 the secondary and so forth. |
| MarkAsDeleted | query | bool | No | Set this to be true if the contact connection to the group is to be deleted |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactId | query | Guid | No | Guid of the contact object within Eros. |
| ContactAlternateKey | query | string | Yes | The unique key that represents the contact on the external system. |
| RoleId | query | Guid | Yes | Guid of the Role List Item object within Eros. |
| RoleAlternateKey | query | string | No | The unique key that represents the role type on the external system. Note: Use of this is not currently implemented |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/SaveContactGroup HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"AlternateKey":"String","IgnoreHash":false,"ContactGroup":{"ContactGroupName":"String","RoleAlternateKey":"String","ContactConnections":[{"Index":0,"MarkAsDeleted":false,"ContactAlternateKey":"String","RoleAlternateKey":"String"}],"MarkAsDeleted":false,"MarkAsArchived":false,"MarkAsRestored":false},"IgnoreValidation":false,"ValidationErrors":[{"RuleCode":"String","Message":"String","Key":"String","Tag":"String","ErrorCode":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}