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

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

    /** @description 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 IsActionArchive: boolean;

    public constructor(init?: Partial<UpdateContactGroupStatus>) { (Object as any).assign(this, init); }
}

TypeScript UpdateContactGroupStatus DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}