POST | /users/invite |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EmailAddress | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Invitation | form | Invitation | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FirstName | form | string | No | |
LastName | form | string | No | |
EmailAddress | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Invitation | form | Invitation | 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 /users/invite HTTP/1.1
Host: foundrystage-api-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
emailAddress: String
}
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 } }, invitation: { firstName: String, lastName: String, emailAddress: String } }