Platform API

UpdateContactGroupStatus

Archives or Restores a Contact Group record.

The following routes are available for this service:
PUT	/api/contactgroup/{ContactGroupId}/archive
PUT	/api/contactgroup/{ContactGroupId}/restore

import Foundation
import ServiceStack

/**
* Archives or Restores a Contact Group record.
*/
// @Api(Description="Archives or Restores a Contact Group record.")
public class UpdateContactGroupStatus : Codable
{
    /**
    * ContactGroupId of the Contact group to be deleted
    */
    // @ApiMember(Description="ContactGroupId of the Contact group to be deleted", Name="ContactGroupId")
    public var contactGroupId:String

    /**
    * True if the action is Archive, False for Restore.
    */
    // @ApiMember(DataType="bool", Description="True if the action is Archive, False for Restore.", IsRequired=true, Name="IsActionArchive", ParameterType="query")
    public var isActionArchive:Bool?

    required public init(){}
}

Swift UpdateContactGroupStatus DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
	}
}