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
"use strict";
export class StringResponse {
    /** @param {{Result?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Result;
}
export class UpdateContactGroupOrder {
    /** @param {{ContactGroupConnectionId?:string,Index?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Connection of contact to update index in the group */
    ContactGroupConnectionId;
    /**
     * @type {number}
     * @description The index of the contact in the group */
    Index;
}

JavaScript UpdateContactGroupOrder 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.

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

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

{"Result":"String"}