Platform API

<back to all web services

UpdateContactGroupStatus

Archives or Restores a Contact Group record.

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Archives or Restores a Contact Group record.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateContactGroupStatus:
    """
    Archives or Restores a Contact Group record.
    """

    # @ApiMember(Description="ContactGroupId of the Contact group to be deleted", Name="ContactGroupId")
    contact_group_id: Optional[str] = None
    """
    ContactGroupId of the Contact group to be deleted
    """


    # @ApiMember(DataType="bool", Description="True if the action is Archive, False for Restore.", IsRequired=true, Name="IsActionArchive", ParameterType="query")
    is_action_archive: Optional[bool] = None
    """
    True if the action is Archive, False for Restore.
    """

Python UpdateContactGroupStatus DTOs

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