Usage
Contacts represent people or companies that are used frequently in Goana. This resource is not available for the free plan.
Definition
| Field |
Type |
Description |
(M)andatory / (O)ptional |
Default Value (If Optional) |
|---|---|---|---|---|
| Reference |
String(200) |
Unique Reference Number | M | null |
| LanguageCode | String(2) |
2-Letter ISO language code, such as "en" | O |
API-users language |
| Team | String(200) |
Team for which the contact is visible. If null the contact can be accessed by all teams. | O |
null |
| Salutation | String(100) | Salutation of the address. Can only be empty, "Mr" or "Mrs" | O | Empty |
| CompanyName | String(200) |
Company Name | M* | null |
| FirstName | String(200) |
First name | O | null |
| Name | String(200) |
Surname | M* | null |
| Role | String(200) |
O |
Calculated-Automatically |
|
| DisplayName | String(500) |
Display name for the contact. Usually leave this blank unless you want to overwrite the default | O |
Set automatically to {Company Name} {Firstname} {Name} |
| Remarks | String | Remarks for the contact | O | null |
| Location | Object(Location) | Location object | M | null |
| ContactDetails | List<Object> | A List of ContactDetail objects | O | null |
| * Either one must be provided |
Example
{
"Reference": "AB123",
"LanguageCode": "de",
"Team": "ABM",
"Salutation":"Mr",
"CompanyName": "ACME Inc.",
"FirstName": "James",
"Name": "Molleston",
"Role": "CEO",
"Remarks": "A great guy",
"Location": {
"Street": "Main Street",
"StreetNumber": "12/13",
"StreetSupplement": "Building A",
"Zip": "3006",
"City": "Bern",
"CountryIsoCode": "CH",
"Latitude": 42.1232,
"Longitude": 7.1233
},
"ContactDetails": [
{
"Name": "Work-Email",
"Type": "Email",
"Value": "jm@goana.net",
"IsPreferred": false
},
{
"Type": "Phone",
"Value": "+4131 333 09 00",
"IsPreferred": true
}
]
}