POST api/Swiftpage

Request Information

URI Parameters

None.

Body Parameters

swiftpageCustomer
NameDescriptionTypeAdditional information
CustomerName

string

None.

CRMID

string

None.

userName

string

None.

FirstName

string

None.

LastName

string

None.

EmailAddress

string

None.

PortalSecurityRolesId

integer

None.

AdditionalSendLimit

integer

None.

SparkPost

Collection of MailServer

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerName": "sample string 1",
  "CRMID": "sample string 2",
  "userName": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "EmailAddress": "sample string 6",
  "PortalSecurityRolesId": 7,
  "AdditionalSendLimit": 8,
  "SparkPost": [
    {
      "Id": "sample string 1",
      "CustomerId": "sample string 2",
      "APIKey": "sample string 3",
      "SubAccountId": "sample string 4",
      "DomainName": "sample string 5",
      "ClickURL": "sample string 6"
    },
    {
      "Id": "sample string 1",
      "CustomerId": "sample string 2",
      "APIKey": "sample string 3",
      "SubAccountId": "sample string 4",
      "DomainName": "sample string 5",
      "ClickURL": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:
<swiftpageCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <AdditionalSendLimit>8</AdditionalSendLimit>
  <CRMID>sample string 2</CRMID>
  <CustomerName>sample string 1</CustomerName>
  <EmailAddress>sample string 6</EmailAddress>
  <FirstName>sample string 4</FirstName>
  <LastName>sample string 5</LastName>
  <PortalSecurityRolesId>7</PortalSecurityRolesId>
  <SparkPost>
    <MailServer>
      <APIKey>sample string 3</APIKey>
      <ClickURL>sample string 6</ClickURL>
      <CustomerId>sample string 2</CustomerId>
      <DomainName>sample string 5</DomainName>
      <Id>sample string 1</Id>
      <SubAccountId>sample string 4</SubAccountId>
    </MailServer>
    <MailServer>
      <APIKey>sample string 3</APIKey>
      <ClickURL>sample string 6</ClickURL>
      <CustomerId>sample string 2</CustomerId>
      <DomainName>sample string 5</DomainName>
      <Id>sample string 1</Id>
      <SubAccountId>sample string 4</SubAccountId>
    </MailServer>
  </SparkPost>
  <userName>sample string 3</userName>
</swiftpageCustomer>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RestAPIResponse
NameDescriptionTypeAdditional information
statusCode

integer

None.

status

string

None.

message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "statusCode": 1,
  "status": "sample string 2",
  "message": "sample string 3"
}

application/xml, text/xml

Sample:
<RestAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <message>sample string 3</message>
  <status>sample string 2</status>
  <statusCode>1</statusCode>
</RestAPIResponse>