GET {clientId}/EmailTypes?Id={Id}&locale={locale}

This method will retrieve all Email Types defined by the client. Optionally you can include a locale to filter the results by a specific locale.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	This is your organization’s MyPreferences Account Id.	string	Required
Id	Optional Type Id. If specified, only the Type with this Id will be returned.	integer	Default value is 0
locale	A valid locale associated with the EmailType. Ex: “en”, “en-us”, “en-uk”, “fr-ca”.	string

Body Parameters

None.

Response Information

Response Codes

HTTP Status Code	Text	Description
200	OK	The request was successfully processed.
400	Bad Request	The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401	Unauthorized	Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403	Forbidden	The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
500	Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.

Resource Description

EmailTypeEntryList

Name	Description	Type	Additional information
EmailTypes	A collection of Email Types that can be associated with a Profile.	Collection of EmailTypeEntry

Response Formats

application/json, text/json, application/json-patch+json

Sample:

{
  "EmailTypes": [
    {
      "TypeId": 1,
      "Edited": {
        "CreateDate": "sample string 1",
        "CreatedBy": "sample string 2",
        "ModifiedDate": "sample string 3",
        "ModifiedBy": "sample string 4"
      },
      "TypeName": "sample string 2",
      "LocalizedFields": [
        {
          "Locale": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        },
        {
          "Locale": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        }
      ],
      "IsDefault": true,
      "IsActive": true
    },
    {
      "TypeId": 1,
      "Edited": {
        "CreateDate": "sample string 1",
        "CreatedBy": "sample string 2",
        "ModifiedDate": "sample string 3",
        "ModifiedBy": "sample string 4"
      },
      "TypeName": "sample string 2",
      "LocalizedFields": [
        {
          "Locale": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        },
        {
          "Locale": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        }
      ],
      "IsDefault": true,
      "IsActive": true
    }
  ]
}

application/xml, text/xml

Sample:

<EmailTypeEntryList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models">
  <EmailTypes>
    <EmailTypeEntry>
      <IsActive>true</IsActive>
      <IsDefault>true</IsDefault>
      <LocalizedFields>
        <LocalizedField>
          <Description>sample string 3</Description>
          <Locale>sample string 1</Locale>
          <Name>sample string 2</Name>
        </LocalizedField>
        <LocalizedField>
          <Description>sample string 3</Description>
          <Locale>sample string 1</Locale>
          <Name>sample string 2</Name>
        </LocalizedField>
      </LocalizedFields>
      <TypeName>sample string 2</TypeName>
      <Edited>
        <CreateDate>sample string 1</CreateDate>
        <CreatedBy>sample string 2</CreatedBy>
        <ModifiedBy>sample string 4</ModifiedBy>
        <ModifiedDate>sample string 3</ModifiedDate>
      </Edited>
      <TypeId>1</TypeId>
    </EmailTypeEntry>
    <EmailTypeEntry>
      <IsActive>true</IsActive>
      <IsDefault>true</IsDefault>
      <LocalizedFields>
        <LocalizedField>
          <Description>sample string 3</Description>
          <Locale>sample string 1</Locale>
          <Name>sample string 2</Name>
        </LocalizedField>
        <LocalizedField>
          <Description>sample string 3</Description>
          <Locale>sample string 1</Locale>
          <Name>sample string 2</Name>
        </LocalizedField>
      </LocalizedFields>
      <TypeName>sample string 2</TypeName>
      <Edited>
        <CreateDate>sample string 1</CreateDate>
        <CreatedBy>sample string 2</CreatedBy>
        <ModifiedBy>sample string 4</ModifiedBy>
        <ModifiedDate>sample string 3</ModifiedDate>
      </Edited>
      <TypeId>1</TypeId>
    </EmailTypeEntry>
  </EmailTypes>
</EmailTypeEntryList>