POST api/v1/Customers

Request Information

URI Parameters

None.

Body Parameters

CreateCustomerRequestMessage
NameDescriptionTypeAdditional information
attributes

CreateCustomerAttributeRequest

None.

type

string

None.

Request Formats

application/json, text/json

Sample:
{
  "attributes": {
    "purchasedProduct": true,
    "enrollmentStatus": true,
    "enrollmentDate": "sample string 2",
    "termsAcceptance": "sample string 3",
    "termsAcceptanceVersion": "sample string 4",
    "dateOfAcceptance": "sample string 5",
    "ApplicationId": "sample string 6",
    "title": "sample string 7",
    "firstName": "sample string 8",
    "mi": "sample string 9",
    "suffix": "sample string 10",
    "lastName": "sample string 11",
    "email": "sample string 12",
    "dateOfBirth": "sample string 13",
    "gender": "sample string 14",
    "preferredLanguage": "sample string 15",
    "primaryPhone": "16",
    "alternatePhone": "17",
    "address": {
      "addressLine1": "sample string 1",
      "addressLine2": "sample string 2",
      "addressLine3": "sample string 3",
      "city": "sample string 4",
      "stateProv": "sample string 5",
      "postalCd": "sample string 6",
      "countryCd": "sample string 7"
    },
    "communicationPreference": [
      {
        "code": "sample string 1",
        "communicationType": "sample string 2",
        "optIn": true,
        "optDate": "sample string 4"
      },
      {
        "code": "sample string 1",
        "communicationType": "sample string 2",
        "optIn": true,
        "optDate": "sample string 4"
      }
    ],
    "externalCustomer": "sample string 18",
    "externalCustomer2": "sample string 19",
    "suspended": true,
    "segments": {
      "vip": 1,
      "crossChannel": 1,
      "rfm": 1
    }
  },
  "type": "sample string 1"
}

application/xml, text/xml

Sample:
<CreateCustomerRequestMessage xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Type>sample string 1</Type>
  <Attributes>
    <Title>sample string 7</Title>
    <FirstName>sample string 8</FirstName>
    <MiddleInitial>sample string 9</MiddleInitial>
    <Suffix>sample string 10</Suffix>
    <LastName>sample string 11</LastName>
    <Email>sample string 12</Email>
    <DateOfBirth>sample string 13</DateOfBirth>
    <Gender>sample string 14</Gender>
    <PreferredLanguage>sample string 15</PreferredLanguage>
    <PrimaryPhone>16</PrimaryPhone>
    <AlternativePhone>17</AlternativePhone>
    <Address>
      <AddressLine1>sample string 1</AddressLine1>
      <AddressLine2>sample string 2</AddressLine2>
      <AddressLine3>sample string 3</AddressLine3>
      <City>sample string 4</City>
      <StateProv>sample string 5</StateProv>
      <PostalCode>sample string 6</PostalCode>
      <CountryCode>sample string 7</CountryCode>
    </Address>
    <CommunicationPreference>
      <CommunicationPrefMessage>
        <Code>sample string 1</Code>
        <CommunicationType>sample string 2</CommunicationType>
        <OptIn>true</OptIn>
        <OptDate>sample string 4</OptDate>
      </CommunicationPrefMessage>
      <CommunicationPrefMessage>
        <Code>sample string 1</Code>
        <CommunicationType>sample string 2</CommunicationType>
        <OptIn>true</OptIn>
        <OptDate>sample string 4</OptDate>
      </CommunicationPrefMessage>
    </CommunicationPreference>
    <ExternalCustomer>sample string 18</ExternalCustomer>
    <ExternalCustomer2>sample string 19</ExternalCustomer2>
    <Suspended>true</Suspended>
    <Segments>
      <Vip>1</Vip>
      <CrossChannel>1</CrossChannel>
      <Rfm>1</Rfm>
    </Segments>
    <ProductsPurchased>true</ProductsPurchased>
    <EnrollmentStatus>true</EnrollmentStatus>
    <EnrollmentDate>sample string 2</EnrollmentDate>
    <TermsAcceptance>sample string 3</TermsAcceptance>
    <TermsAcceptanceVersion>sample string 4</TermsAcceptanceVersion>
    <DateOfAcceptance>sample string 5</DateOfAcceptance>
    <ApplicationId>sample string 6</ApplicationId>
  </Attributes>
</CreateCustomerRequestMessage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateCustomerResponseMessage
NameDescriptionTypeAdditional information
id

string

None.

attributes

CreateCustomerResponse

None.

CustomValues

Dictionary of string [key] and string [value]

None.

CustomValuesSpecified

boolean

None.

Errors

Collection of IPartnerResponseMessageError

None.

Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.