Attributes

  • Version: 1.0
  • Defined types are as configured at a platform (when attached to an Org Identity) or CO (when attached to a CO Person) level. CO-specific types can be determined via the CoExtendedType API.
  • Verified cannot be set to true via this interface. Instead, a confirmation request must be triggered.
  • See cm_email_addresses for definitions of other attributes and elements.

JSON Request

{
  "RequestType":"EmailAddresses",
  "Version":"1.0",
  "EmailAddresses":
  [
    {
      "Version":"1.0",
      "Mail":"<Mail>",
      "Type":"<Type>",
      "Description":"<Description>",
      "Verified":true|false,
      "Person":
      {
        "Type":("CO"|"Dept"|"Org"|"Organization"),
        "Id":"<ID>"
      }
    }
  ]
}

XML Request

<!ELEMENT EmailAddresses (EmailAddress)>
 <!ATTLIST EmailAddresses Version CDATA #FIXED "1.0">
 <!ELEMENT EmailAddress (Mail?,Type?,Person)>
  <!ATTLIST EmailAddress Version CDATA #FIXED "1.0">
  <!ELEMENT Number (#PCDATA)>
  <!ELEMENT Type (#PCDATA)>
  <!ELEMENT Description (#PCDATA)>
  <!ELEMENT Verified (True|False)>
  <!ELEMENT Person (Type,Id)>
   <!ELEMENT Type (CO|Dept|Org|Organization)>
   <!ELEMENT Id (#PCDATA)>

JSON Response

{
  "ResponseType":"EmailAddresses",
  "Version":"1.0",
  "EmailAddresses":
  [
    {
      "Version":"1.0",
      "Id":"<ID>",
      "Mail":"<Mail>",
      "Type":<"Type">,
      "Description":"<Description>",
      "Verified":true|false,
      "Person":
      {
        "Type":("CO"|"Dept"|"Org"|"Organization"),
        "Id":"<ID>"
      }
      "Created":"<CreateTime>",
      "Modified":"<ModTime>"
    },
    {...}
  ]
}

XML Response

<!ELEMENT EmailAddresses (EmailAddress+)>
 <!ATTLIST EmailAddresses Version CDATA #FIXED "1.0">
 <!ELEMENT EmailAddress (Mail?,Type?,Person)>
  <!ATTLIST EmailAddress Version CDATA #FIXED "1.0">
  <!ATTLIST EmailAddress Id ID>
  <!ELEMENT Number (#PCDATA)>
  <!ELEMENT Type (#PCDATA)>
  <!ELEMENT Description (#PCDATA)>
  <!ELEMENT Verified (True|False)>
  <!ELEMENT Person (Type,Id)>
   <!ELEMENT Type (CO|Dept|Org|Organization)>
   <!ELEMENT Id (#PCDATA)>
  <!ELEMENT Created (#PCDATA)>
  <!ELEMENT Modified (#PCDATA)>
  • No labels