| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SuiteDataSourceInstanceId | body | Guid | Yes | Guid representing the external systems datasource information. |
| AlternateKey | body | string | Yes | The unique key that represents the contact group on the external system. |
| ObjectId | body | Guid | No | Guid of the contact group object within PSTPF. If ObjectId is known, the external system may pass this insted of the alternate key. |
| IgnoreHash | body | 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 | body | SubscriptionContactGroupModel | Yes | Object containing all details of the contact group to be inserted or updated. |
| LicenseeId | query | Guid | No | |
| SessionId | query | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ValidationErrors | body | List<RuleValidationResult> | No | List of any validation/errors occuring during a method call |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | body | Guid | No | Validation/Error message details |
| Key | body | Guid | No | Summary/label of validation/error |
| ErrorCode | body | Guid | No | Key/code representing validation/error |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactGroupName | body | string | Yes | A name for the contact group. |
| GroupRoleId | body | Guid | Yes | Guid of the Role List Item object within PSTPF that defines the role of the group. |
| RoleAlternateKey | body | 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 | body | List<SubscriptionContactGroupConnectionModel> | No | A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group. |
| MarkAsDeleted | body | bool | No | Set this to be true if the contact group is to be deleted |
| MarkAsArchived | body | bool | No | Set this to be true if the contact group is to be archived |
| MarkAsRestored | body | bool | No | Set this to be true if the contact group is to be restored |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Index | body | int | No | The order this contact is in priority. 1 would be the primary contact, 2 the secondary and so forth. |
| MarkAsDeleted | body | 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 | body | Guid | No | Guid of the contact object within PSTPF. |
| ContactAlternateKey | body | string | No | The unique key that represents the contact on the external system. |
| RoleId | body | Guid | No | Guid of the Role List Item object within PSTPF. |
| RoleAlternateKey | body | 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 .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsonl/reply/SaveContactGroup HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: text/jsonl
Content-Type: text/jsonl
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},"ValidationErrors":[{"Message":"String","Key":"String","ErrorCode":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}