osapi.jive.corev3.Emails

Emails is a type representing the email addresses for a user. Each user must have a primary email address.

An example JSON representation looks like this:

  [ {
    "value" : "admin@example.com",
    "type" : "work",
    "jive_label" : "Email",
    "primary" : true
  } ]

Fields

Field Type Mode † Description
jive_label String required

For primary emails the value must be "Email". To learn the list of email fields available in a Jive instance do a GET to /metadata/objects/emails. When using the Javascript API then execute metadata.getObjectMetadata("emails").
value String required

A valid email address. Primary emails must be unique across the system.
type String optional

Possible values are home, other or work.
primary Boolean read-only

true if this is the primary email address.

†
→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations

Properties

Properties

PropertyTypeMode †Description
typeCodeIntegerread-only↑
†
→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations