POST api/SecureRecipients

Creates a new secure recipient or updates an existent secure recipient's information.

Request Information

URI Parameters

None.

Body Parameters

SecureRecipientModel
NameDescriptionTypeAdditional information
Name

Secure recipient name.

 string

None.
NotificationsEmailAddress

Notifications email address.

 string

None.
Id

Unique ID of the model in the portal (Read only).

 globally unique identifier

None.
ExternalId

Unique ID of the model on integrating system (Required).

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "notificationsEmailAddress": "sample string 2",
  "id": "aa3c9760-9202-4b88-8562-102d49c47cf2",
  "externalId": "sample string 4"
}

application/xml, text/xml

Sample: 
<SecureRecipientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.SecureRecipients">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 4</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">aa3c9760-9202-4b88-8562-102d49c47cf2</Id>
  <Name>sample string 1</Name>
  <NotificationsEmailAddress>sample string 2</NotificationsEmailAddress>
</SecureRecipientModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SecureRecipientModel'.

Response Information

Resource Description

SecureRecipientModel
NameDescriptionTypeAdditional information
Name

Secure recipient name.

 string

None.
NotificationsEmailAddress

Notifications email address.

 string

None.
Id

Unique ID of the model in the portal (Read only).

 globally unique identifier

None.
ExternalId

Unique ID of the model on integrating system (Required).

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "notificationsEmailAddress": "sample string 2",
  "id": "bea14af5-7f50-459f-b719-2b90da46bc76",
  "externalId": "sample string 4"
}

application/xml, text/xml

Sample: 
<SecureRecipientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.SecureRecipients">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 4</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">bea14af5-7f50-459f-b719-2b90da46bc76</Id>
  <Name>sample string 1</Name>
  <NotificationsEmailAddress>sample string 2</NotificationsEmailAddress>
</SecureRecipientModel>