Platform API

ConnectContactsInRoles

Connect two contacts in the specified roles

The following routes are available for this service:
All Verbs	/api/connections/{ContactId}/to/{ToContactId}

"use strict";
export class ConnectContactsInRolesResponse {
    /** @param {{ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ConnectContactsInRoles {
    /** @param {{ContactId?:string,ToContactId?:string,ContactTypeId?:string,Roles?:string[],SendConnectionEmails?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Create a connection from this contact to the specified to contact in the specified roles. */
    ContactId;
    /**
     * @type {string}
     * @description Create a connection to this contact from the specified to contact in the specified roles. */
    ToContactId;
    /**
     * @type {string}
     * @description Type of contact being connected with. For e.g. Real Person, Virtual Person etc. */
    ContactTypeId;
    /**
     * @type {string[]}
     * @description List of roles to connect contacts in */
    Roles = [];
    /**
     * @type {boolean}
     * @description Send connection emails for auto - accept roles that are being assigned? Note: emails will always be sent if the role requires user acceptance */
    SendConnectionEmails;
}

JavaScript ConnectContactsInRoles DTOs

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

HTTP + OTHER

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

POST /api/connections/{ContactId}/to/{ToContactId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ContactId":"00000000-0000-0000-0000-000000000000","ToContactId":"00000000-0000-0000-0000-000000000000","ContactTypeId":"00000000-0000-0000-0000-000000000000","Roles":["00000000-0000-0000-0000-000000000000"],"SendConnectionEmails":false}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}