POST api/Communication/BrandEmail

Creates a new communication in CRM for the brand-level e-mail newsletter

Request Information

URI Parameters

None.

Body Parameters

The communication to be created

Name	Type	Additional information
SalesLiteratureId	globally unique identifier	None.
Name	string	None.
ContactId	globally unique identifier	None.
EmailAddress	string	None.
PhoneNumber	string	None.
FirstName	string	None.
LastName	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
City	string	None.
StateOrProvince	string	None.
Country	string	None.
ZipCode	string	None.
Contact	UWEOContact	None.
CrmContactId	globally unique identifier	None.
CrmEntityType	string	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "SalesLiteratureId": "6e5fb230-ff14-4dc8-9e73-26a6098c3108",
  "Name": "sample string 1",
  "ContactId": "e6b5679e-1703-4d5d-ade2-3cbe17368b2c",
  "EmailAddress": "sample string 2",
  "PhoneNumber": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "AddressLine1": "sample string 6",
  "AddressLine2": "sample string 7",
  "City": "sample string 8",
  "StateOrProvince": "sample string 9",
  "Country": "sample string 10",
  "ZipCode": "sample string 11",
  "Contact": {
    "ContactId": "c022a9ab-11fb-451a-b698-487129e79da1",
    "FirstName": "sample string 1",
    "MiddleName": "sample string 2",
    "LastName": "sample string 3",
    "FullName": "sample string 4",
    "EMailAddress1": "sample string 5",
    "EMailAddress2": "sample string 6",
    "EMailAddress3": "sample string 7",
    "Addresses": [
      {
        "ContactId": "fa38f296-3a66-4c07-a200-d0108b93cb74",
        "AddressNumber": 1,
        "CustomerAddressId": "c13bbccf-b976-4fd7-9f2b-7eb64f94c25f",
        "AddressTypeCode": 1,
        "Line1": "sample string 2",
        "Line2": "sample string 3",
        "Line3": "sample string 4",
        "City": "sample string 5",
        "StateOrProvince": "sample string 6",
        "County": "sample string 7",
        "Country": "sample string 8",
        "CrmContactId": "7c33380b-b764-4a73-b169-b3233b4d55ae",
        "CrmEntityType": "sample string 9"
      },
      {
        "ContactId": "fa38f296-3a66-4c07-a200-d0108b93cb74",
        "AddressNumber": 1,
        "CustomerAddressId": "c13bbccf-b976-4fd7-9f2b-7eb64f94c25f",
        "AddressTypeCode": 1,
        "Line1": "sample string 2",
        "Line2": "sample string 3",
        "Line3": "sample string 4",
        "City": "sample string 5",
        "StateOrProvince": "sample string 6",
        "County": "sample string 7",
        "Country": "sample string 8",
        "CrmContactId": "7c33380b-b764-4a73-b169-b3233b4d55ae",
        "CrmEntityType": "sample string 9"
      }
    ],
    "BirthDate": "2026-06-05T15:22:35.7756541-07:00",
    "JobTitle": "sample string 8",
    "Telephone1": "sample string 9",
    "Fax": "sample string 10",
    "AreaofStudy": "sample string 11",
    "GenderCode": 1,
    "CreatedOn": "2026-06-05T15:22:35.7756541-07:00",
    "Company": "sample string 12",
    "EOSPersonId": 1,
    "UWStudentId": "sample string 13",
    "NickName": "sample string 14",
    "LastEnrollment": "fb8953c1-4a3b-4a80-9a12-4aae3a21c184",
    "LastEnrollmentDate": "2026-06-05T15:22:35.7756541-07:00",
    "CrmContactId": "802b9ab0-9055-4a27-b231-b9dc52093b7d",
    "CrmEntityType": "sample string 15"
  },
  "CrmContactId": "63d155a0-04da-43ba-9a86-9945103924fc",
  "CrmEntityType": "sample string 12"
}

application/xml, text/xml

Sample:

<UWEOCommunication xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UWEO.CRM.API.Base.Models">
  <CrmContactId>63d155a0-04da-43ba-9a86-9945103924fc</CrmContactId>
  <CrmEntityType>sample string 12</CrmEntityType>
  <AddressLine1>sample string 6</AddressLine1>
  <AddressLine2>sample string 7</AddressLine2>
  <City>sample string 8</City>
  <Contact>
    <CrmContactId>802b9ab0-9055-4a27-b231-b9dc52093b7d</CrmContactId>
    <CrmEntityType>sample string 15</CrmEntityType>
    <Addresses>
      <UWEOContactAddress>
        <CrmContactId>7c33380b-b764-4a73-b169-b3233b4d55ae</CrmContactId>
        <CrmEntityType>sample string 9</CrmEntityType>
        <AddressNumber>1</AddressNumber>
        <AddressTypeCode>1</AddressTypeCode>
        <City>sample string 5</City>
        <ContactId>fa38f296-3a66-4c07-a200-d0108b93cb74</ContactId>
        <Country>sample string 8</Country>
        <County>sample string 7</County>
        <CustomerAddressId>c13bbccf-b976-4fd7-9f2b-7eb64f94c25f</CustomerAddressId>
        <Line1>sample string 2</Line1>
        <Line2>sample string 3</Line2>
        <Line3>sample string 4</Line3>
        <ParentId>1098fc22-0e5e-4219-ad83-4a9fcace216c</ParentId>
        <StateOrProvince>sample string 6</StateOrProvince>
      </UWEOContactAddress>
      <UWEOContactAddress>
        <CrmContactId>7c33380b-b764-4a73-b169-b3233b4d55ae</CrmContactId>
        <CrmEntityType>sample string 9</CrmEntityType>
        <AddressNumber>1</AddressNumber>
        <AddressTypeCode>1</AddressTypeCode>
        <City>sample string 5</City>
        <ContactId>fa38f296-3a66-4c07-a200-d0108b93cb74</ContactId>
        <Country>sample string 8</Country>
        <County>sample string 7</County>
        <CustomerAddressId>c13bbccf-b976-4fd7-9f2b-7eb64f94c25f</CustomerAddressId>
        <Line1>sample string 2</Line1>
        <Line2>sample string 3</Line2>
        <Line3>sample string 4</Line3>
        <ParentId>1098fc22-0e5e-4219-ad83-4a9fcace216c</ParentId>
        <StateOrProvince>sample string 6</StateOrProvince>
      </UWEOContactAddress>
    </Addresses>
    <AreaofStudy>sample string 11</AreaofStudy>
    <BirthDate>2026-06-05T15:22:35.7756541-07:00</BirthDate>
    <Company>sample string 12</Company>
    <ContactId>c022a9ab-11fb-451a-b698-487129e79da1</ContactId>
    <CreatedOn>2026-06-05T15:22:35.7756541-07:00</CreatedOn>
    <EMailAddress1>sample string 5</EMailAddress1>
    <EMailAddress2>sample string 6</EMailAddress2>
    <EMailAddress3>sample string 7</EMailAddress3>
    <EOSPersonId>1</EOSPersonId>
    <Fax>sample string 10</Fax>
    <FirstName>sample string 1</FirstName>
    <FullName>sample string 4</FullName>
    <GenderCode>1</GenderCode>
    <JobTitle>sample string 8</JobTitle>
    <LastEnrollment>fb8953c1-4a3b-4a80-9a12-4aae3a21c184</LastEnrollment>
    <LastEnrollmentDate>2026-06-05T15:22:35.7756541-07:00</LastEnrollmentDate>
    <LastName>sample string 3</LastName>
    <MiddleName>sample string 2</MiddleName>
    <NickName>sample string 14</NickName>
    <Telephone1>sample string 9</Telephone1>
    <UWStudentId>sample string 13</UWStudentId>
  </Contact>
  <ContactId>e6b5679e-1703-4d5d-ade2-3cbe17368b2c</ContactId>
  <Country>sample string 10</Country>
  <EmailAddress>sample string 2</EmailAddress>
  <FirstName>sample string 4</FirstName>
  <LastName>sample string 5</LastName>
  <Name>sample string 1</Name>
  <PhoneNumber>sample string 3</PhoneNumber>
  <SalesLiteratureId>6e5fb230-ff14-4dc8-9e73-26a6098c3108</SalesLiteratureId>
  <StateOrProvince>sample string 9</StateOrProvince>
  <ZipCode>sample string 11</ZipCode>
</UWEOCommunication>

Response Information

Resource Description

The location of the created object

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.