Platform API

<back to all web services

InviteVirtualContact

Requires Authentication
The following routes are available for this service:
All Verbs/api/contacts/invitevirtualcontact
InviteVirtualContact Parameters:
NameParameterData TypeRequiredDescription
ContactIdqueryGuidNo
EmailAddressquerystringNo
RolesqueryList<Guid>No
InviteVirtualContactResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
ResponseStatusformResponseStatusNo

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/contacts/invitevirtualcontact HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ContactId":"00000000-0000-0000-0000-000000000000","EmailAddress":"String","Roles":["00000000-0000-0000-0000-000000000000"]}

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

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