POST api/v1/contact/invite
Record the invitation of a potential StratusCore contact
Request Information
URI Parameters
None.
Body Parameters
InvitedContactBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Authentication | AuthenticationModel |
Required |
|
| Request | InvitedContactRequestModel |
Required |
Request Formats
application/json, text/json
Sample:
{
"Authentication": {
"Id": "170200123 - sample only, user your ID",
"Key": "467512342123 - sample only, user your Key"
},
"Request": {
"ExistingContactEmail": "larry@newmedia.com",
"InvitedContactEmail": "larry2@newmedia.com",
"Context": "Collaborating on new project (example)"
}
}
application/xml, text/xml
Sample:
<InvitedContactBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiModels">
<Authentication xmlns:d2p1="http://schemas.datacontract.org/2004/07/Api.Models">
<d2p1:Id>170200123 - sample only, user your ID</d2p1:Id>
<d2p1:Key>467512342123 - sample only, user your Key</d2p1:Key>
</Authentication>
<Request>
<Context>Collaborating on new project (example)</Context>
<ExistingContactEmail>larry@newmedia.com</ExistingContactEmail>
<InvitedContactEmail>larry2@newmedia.com</InvitedContactEmail>
</Request>
</InvitedContactBindingModel>
Response Information
Resource Description
ContactsOutgoingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Message | MessageModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"Message": {
"Code": "(2 digit code reflecting result of request - 00 is good)",
"Description": "(Message response in text depending upon request/result of request)"
}
}
application/xml, text/xml
Sample:
<ContactsOutgoingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiModels">
<Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/Api.Models">
<d2p1:Code>(2 digit code reflecting result of request - 00 is good)</d2p1:Code>
<d2p1:Description>(Message response in text depending upon request/result of request)</d2p1:Description>
</Message>
</ContactsOutgoingModel>