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 .xml suffix or ?format=xml

HTTP + XML

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

<UpdateContactGroupStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactGroupId>00000000-0000-0000-0000-000000000000</ContactGroupId>
  <IsActionArchive>false</IsActionArchive>
</UpdateContactGroupStatus>

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

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>