EmailField

• Available Since API Version – 2.4\

The EmailField type is used to represent email addresses in Octopus API. EmailField objects contain the following properties:

• Default - A BooleanField indicating if this email address is selected as the default email address for the entry.\

• Description - A StringField containing the description field for the email address.\

• Address - A StringField containing the email address.\

Basic Read Request

The following example illustrates the syntax for a request for the default value of an EmailField in a Read method call.

Request

{
  "Email":1
}

Response

{
  "Email":"[email protected]"
}

Detailed Read Request

The following example illustrates the syntax for a request for all properties of an EmailField in a Read method call.

Request

{
  "Email":{
    "Default":1,
    "Description":1,
    "Address":1
  }
}

Response

{
  "Email":{
    "Default":true,
    "Description":"Main",
    "Address":"[email protected]"
  }
}

Create/Update Request

The following example illustrates the syntax for including an EmailField in a Create or Update method call.

Request

{
  "Email":{
    "Description":"Work",
    "Address":"[email protected]"
  }
}

Response

{
  "Email":{
    "Description":"Work",
    "Address":"[email protected]"
  }
}