Provides contact information for a client. Also should match gds information for this client.
| name | data type | constraints | description |
|---|---|---|---|
| client | Client | required | The client that this contact info is for. |
| position | number | Position (1-6) of this contact on the contact page | |
| name | string | Name of the person who is the clients contact. | |
| title | string | Name of the person who is the clients contact. | |
| phone | string | Phone number of the client's contact person. | |
| ext | string | ||
| phone2 | string | Another phone number of the client's contact person. | |
| ext2 | string | ||
| string | Contact email of the clients contact person. | ||
| address1 | string | First line of address for this client | |
| address2 | string | Second line of address for this client | |
| city | string | City of address for this client | |
| state | string | State/Country of address for this client | |
| zip | string | Postal code of address for this client | |
| keyContact | boolean | required boolean | Whether or not this contact is considered a 'key contact' that should be considered a primary point of communication. |
| hubspotSynced | boolean | required boolean | |
| role | string | ||
Properties inherited from BaseHibernateEntity |
|||
| id | number | The unique internal ID of the object. | |
| version | number | For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions. | |
Properties inherited from BaseEntity |
|||
| violations | array of SimpleViolation | A list of constraint violations, if any, that this object has. | |
Example
{
"client" : {
"status" : {
"name" : "...",
"active" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"parentClient" : { },
"accountNumber" : "...",
"name" : "...",
"type" : {
"name" : "...",
"hide" : true,
"level" : 12345,
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"position" : 12345,
"name" : "...",
"title" : "...",
"phone" : "...",
"ext" : "...",
"phone2" : "...",
"ext2" : "...",
"email" : "...",
"address1" : "...",
"address2" : "...",
"city" : "...",
"state" : "...",
"zip" : "...",
"keyContact" : true,
"hubspotSynced" : true,
"role" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}