| All Verbs | /api/contacts/{ContactId}/invite/contact | ||
|---|---|---|---|
| All Verbs | /api/contacts/{ContactId}/invite/{ToContactId} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactId | path | Guid | Yes | Contact Id inviting the contact |
| ToContactId | path | Guid | No | Contact Id of the virtual contact invited to be real. |
| EmailAddress | query | string | Yes | Email Address of the real/ virtual contact to be invited. |
| Roles | query | List<Guid> | Yes | List of roles to invite the contact |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactId | form | Guid | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contacts/{ContactId}/invite/contact HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
EmailAddress: String,
Roles:
[
00000000-0000-0000-0000-000000000000
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}