POST api/{version}/Activate?sendActivationEmail={sendActivationEmail}&origin={origin}

Obtains a key to encrypt the email body and attachments. The credentials being sent must belong to a Delivery Trust account that has the "Delivery Trust" product level.

Request Information

URI Parameters

Name	Description	Type	Additional information
sendActivationEmail	Have Delivery Trust send a getting started email if the request is successful.	boolean	Default value is True
origin	The app that wants to activate. Can be Outlook add-in or Outlook 365. For internal use only.	string	None.
version		string	None.

Body Parameters

The activation request.

ActivateRequest

Name	Description	Type	Additional information
ClientMetaData	Optional metadata related to the client platform. The Delivery Trust plugin populates this object with information such as operating system, Outlook version and information about the account type that is being used (pop, imap etc) that our support personnel can use for troubleshooting purposes.	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientMetaData": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<ActivateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Models">
  <ClientMetaData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ClientMetaData>
</ActivateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/bson

Sample:

Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

Returns an API key to use for subsequent API operations.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.