Platform API

<back to all web services

UpdateContactGroupStatus

Archives or Restores a Contact Group record.

Requires Authentication
The following routes are available for this service:
PUT/api/contactgroup/{ContactGroupId}/archive
PUT/api/contactgroup/{ContactGroupId}/restore
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

    /**
    * 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")
    open var IsActionArchive:Boolean? = null
}

Kotlin UpdateContactGroupStatus DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ContactGroupId":"00000000-0000-0000-0000-000000000000","IsActionArchive":false}

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"}}