Platform API

<back to all web services

UpdateContactGroupOrder

Update the order of contacts in the specified contact group

Requires Authentication
The following routes are available for this service:
All Verbs/api/contactgroups/updatecontactgrouporder

export class StringResponse
{
    public Result: string;

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

/** @description Update the order of contacts in the specified contact group */
// @Api(Description="Update the order of contacts in the specified contact group")
export class UpdateContactGroupOrder
{
    /** @description Connection of contact to update index in the group */
    // @ApiMember(Description="Connection of contact to update index in the group", Name="ContactGroupConnectionId")
    public ContactGroupConnectionId: string;

    /** @description The index of the contact in the group */
    // @ApiMember(Description="The index of the contact in the group", Name="Index")
    public Index: number;

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

TypeScript UpdateContactGroupOrder DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/contactgroups/updatecontactgrouporder HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ContactGroupConnectionId":"00000000-0000-0000-0000-000000000000","Index":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Result":"String"}