| PUT | /api/contactgroup/{ContactGroupId}/archive | ||
|---|---|---|---|
| PUT | /api/contactgroup/{ContactGroupId}/restore |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactGroupId | path | Guid | No | ContactGroupId of the Contact group to be deleted |
| IsActionArchive | query | bool | Yes | True if the action is Archive, False for Restore. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /api/contactgroup/{ContactGroupId}/archive HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
IsActionArchive: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}