Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.

Contact Attributes

Contact Attribute Fields

Name	Data Type (Length)	Read-Only	Description
id	long	x	The internal ID of the attribute.
name	string (40)		The name of the attribute (i.e., the additional information field).
displayFormat	String (1)		There are three constants for displayFormat (case-sensitive): ◊ F — text box ◊ L — single selection list ◊ S — multiple selection list
dataType	String (6)		There are three constants for dataType (case-sensitive): ◊ STRING ◊ DATE (date only, no time) ◊ NUMBER
expose	boolean		Whether or not this field is visible on the Member Portal.
editable	boolean		Whether or not this field is editable on the Member Portal.
mandatory	boolean		Whether or not this field is mandatory on the Member Portal.
definedValues	String[]		Required if displayFormat is L or S. An array of strings which make up the select list values.
createdDate	long	x	Unix epoch date/time when the attribute was created. See tools for date/time conversion functions.
createdId	long	x	Internal ID of the user that created this attribute.
createdName	String	x	First and last name of the user that create this attribute.
lastModifiedDate	integer($int64)	x	Unix epoch date/time when the attribute was last modified. See tools for date/time conversion functions.
lastModifiedId	long	x	Internal ID of the user that last modified this attribute.
accountId	long
status
resourceBundleId	long
organizationId	long	x	The ID of the organization to which this attribute belongs.
seq

GET /contactAttributes/{organizationId}/{contactAttributeId}

Description

Retrieve the specified contact attribute within an organization.

Return type

OrganizationContactAttributeWrapperinstanceResult

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the contact attribute.
contactAttributeId	long	y	The ID of the contact attribute to return.

Returns

{
  "id": 3549227829428286,
  "name": "Building",
  "displayFormat": "L",
  "dataType": "STRING",
  "expose": true,
  "editable": true,
  "mandatory": false,
  "definedValues": [],
  "createdDate": 1395250397948,
  "createdId": 892807736721858,
  "createdName": "Mike Wallick",
  "lastModifiedDate": 1406139458889,
  "lastModifiedId": 892807736721858,
  "lastModifiedName": "Mike Wallick",
  "accountId": 1772417038942236,
  "status": "A",
  "resourceBundleId": 0,
  "organizationId": 892807736721854,
  "seq": 0
}

GET /contactAttributes/{organizationId}

Description

Retrieve all contact attributes in this organization.

Return type

OrganizationContactAttributeWrapperCollectionResult

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the contactAttribute.

Returns

{
  "message": "OK",
  "firstPageUri": "https://api.everbridge.net/rest/contactAttributes/{organizationId}/?pageNumber=1",
  "nextPageUri": "https://api.everbridge.net/rest/contactAttributes/{organizationId}/?pageNumber=2",
  "lastPageUri": "https://api.everbridge.net/rest/contactAttributes/{organizationId}/?pageNumber=1",
  "page": {
    "pageSize": 20,
    "start": 1,
    "data": [
      {
        "attribute1": "removed for reading posterity."
      },
      {
        "attribute2": "removed for reading posterity."
      }
    ],
    "totalCount": 20,
    "totalPageCount": 1,
    "currentPageNo": 1
  }
}

POST /contactAttributes/{organizationId}

Description

Create a new contact attribute within an organization.

Return type

RestfulModificationResult

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the contactAttribute.
contactAttribute	OrganizationContactAttributeWrapper	y	The JSON object describing the new contact attribute.

Request Body

Field	Data Type (Length)	Notes
name	String (40)	The name of the attribute (i.e., the additional information field).
displayFormat	String	There are three constants for displayFormat (case-sensitive): ◊ F — text box ◊ L — single selection list ◊ S — multiple selection list
dataType	String	There are three constants for dataType (case-sensitive): ◊ STRING ◊ DATE (date only, no time) ◊ NUMBER
expose	boolean	Whether or not this field is visible on the Member Portal.
editable	boolean	Whether or not this field is ediatable on the Member Portal.
mandatory	boolean	Whether or not this field is mandatory on the Member Portal.
definedValues	String[]	Required if displayFormat is L or S. An array of strings which make up the select list values.

Textbox that stores numbers

{
  "name": "Text Field Name",
  "displayFormat": "F",
  "dataType": "NUMBER"
}

Textbox that is visible and editable on the member portal (but not mandatory)

{
  "name": "Text Field Name",
  "displayFormat": "F",
  "dataType": "DATE",
  "expose": true,
  "editable": true,
  "mandatory": false
}

Single select list that stores strings

{
  "name": "Text Field Name",
  "displayFormat": "L",
  "dataType": "STRING",
  "definedValues": [
    "option 1",
    "option 2",
    "option 3"
  ]
}

Multiple select list that stores strings

{
  "name": "Text Field Name",
  "displayFormat": "S",
  "dataType": "STRING",
  "definedValues": [
    "option 4",
    "option 5",
    "option 6"
  ]
}

Returns

{
  "message": "OK",
  "id": "{the internal id of the record just created}",
  "baseUri": "https://api.everbridge.net/rest/contactAttributes/{organizationId}/",
  "instanceUri": "https://api.everbridge.net/rest/contactAttributes/{organizationId}/{contactAttributeId}"
}

PUT /contactAttributes/{organizationId}/{contactAttributeId}

Description

Update a contact attribute within an organization.

Return type

RestfulModificationResult

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the contact attribute.
contactAttributeId	long	y	The ID of the contact attribute to update.
contactAttribute	OrganizationContactAttributeWrapper	y	The JSON object describing the updated contact attribute.

Request Body

See POST /contactAttributes/{organizationId}

Returns

{
  "message": "OK",
  "id": "{the internal id of the record just created}",
  "baseUri": "https://api.everbridge.net/rest/contactAttributes/{organizationId}/",
  "instanceUri": "https://api.everbridge.net/rest/contactAttributes/{organizationId}/{contactAttributeId}"
}

DELETE /contactAttributes/{organizationId}/{contactAttributeId}

Description

Delete the specified contact attribute from an organization.

Return type

RestfulModificationResult

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the contact attribute.
contactAttributeId	long	y	The ID of the contact attribute to delete.

Request Body

None

Returns

{
  "message": "OK",
  "id": "{the internal id of the record just deleted}",
  "baseUri": "https://api.everbridge.net/rest/contactAttributes/{organizationId}/",
  "instanceUri": "https://api.everbridge.net/rest/contactAttributes/{organizationId}/{contactAttributeId}"
}