Platform API

<back to all web services

UpdateContactGroupStatus

Archives or Restores a Contact Group record.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Archives or Restores a Contact Group record.
    ///</summary>
    [Api(Description="Archives or Restores a Contact Group record.")]
    public partial class UpdateContactGroupStatus
    {
        ///<summary>
        ///ContactGroupId of the Contact group to be deleted
        ///</summary>
        [ApiMember(Description="ContactGroupId of the Contact group to be deleted", Name="ContactGroupId")]
        public virtual Guid ContactGroupId { get; set; }

        ///<summary>
        ///True if the action is Archive, False for Restore.
        ///</summary>
        [ApiMember(DataType="bool", Description="True if the action is Archive, False for Restore.", IsRequired=true, Name="IsActionArchive", ParameterType="query")]
        public virtual bool? IsActionArchive { get; set; }
    }

}

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