Contact
A single contact.
More info: see the get operation and the contacts endpoint.
Fields
| Field | Description |
|---|---|
id int (required) | Contact ID Example value:9364924 |
addresses Address[] | Addresses Example value:[ { "id": 28, "typeid": 1, "city": "Leuven", "country": "Belgium", "countrycode": "BE", "customerid": 9364924, "street1": "Main street", "type": "Home", "zip": "3000" } ] |
appnotifications int[] | App notifications Example value:[ 31001 ] |
apponboardingstatus int | App onboardingstatus Example value:32001 |
appoptin | App optin Example value:{ "ip": "192.168.1.1", "message": "I accept", "method": "web", "status": true, "ts": "2018-03-26 15:32:17" } |
appphone string | App phone Example value:"+32473112233" |
apptoken string | App token Example value:"eyJhbGciOiJSUzI1NiIsInR5cCI6I" |
birthdate timestamp | Birth date Example value:"1986-09-26" |
company string | Company Example value:"Mega Corp" |
customertitleid int | Customer title ID (also determines the gender of the contact) Example value:12 |
email string (required) | E-mail address Example value:"developers@ticketmatic.com" |
firstname string | First name Example value:"John" |
image string | Image url Example value:"https://www.ticketmatic.com/image.jpg" |
languagecode string | Language (ISO 639-1 code) Example value:"NL" |
lastname string | Last name Example value:"Doe" |
lookup map<string, mixed> (required) | Related objects Example value:{ "contacts": [] } |
middlename string | Middle name Example value:"K" |
optins | A list of opt ins Example value:[ { "id": 29323, "info": { "method": "boxoffice", "remarks": "The customer accepted the terms." }, "optinid": 827, "status": 7602 } ] |
organizationfunction string | Job function Example value:"Director of ticketing" |
phonenumbers | Phone numbers Example value:[ { "id": 123, "typeid": 3, "customerid": 9364924, "number": "+3216881940", "type": "Home" } ] |
relationships | A list of contact relationships Example value:[ { "id": 1, "typeid": 47001, "childcontactid": 10000, "parentcontactid": 9364924 } ] |
relationtypes int[] | Relation type IDs Example value:[ 1, 2 ] |
sendmail bool (required) | |
sex string | Sex Example value:"M" |
status string (required) | Contact status Possible values:
"incomplete" |
subscribed bool (required) | Whether or not this contact is subscribed in the e-mail marketing integration |
vatnumber string | VAT Number (for organizations) Example value:"BE123456789" |
isdeleted bool (required) | Whether or not this contact has been deleted |
createdts timestamp (required) | Created timestamp Example value:"2014-09-26 15:24:36" |
lastupdatets timestamp (required) | Last updated timestamp Example value:"2014-09-26 15:24:36" |
This type can have custom fields
Example
1{
2 "id": 9364924,
3 "addresses": [
4 {
5 "id": 28,
6 "typeid": 1,
7 "city": "Leuven",
8 "country": "Belgium",
9 "countrycode": "BE",
10 "customerid": 9364924,
11 "street1": "Main street",
12 "type": "Home",
13 "zip": "3000"
14 }
15 ],
16 "appnotifications": [ 31001 ],
17 "apponboardingstatus": 32001,
18 "appoptin": {
19 "ip": "192.168.1.1",
20 "message": "I accept",
21 "method": "web",
22 "status": true,
23 "ts": "2018-03-26 15:32:17"
24 },
25 "appphone": "+32473112233",
26 "apptoken": "eyJhbGciOiJSUzI1NiIsInR5cCI6I",
27 "birthdate": "1986-09-26",
28 "company": "Mega Corp",
29 "customertitleid": 12,
30 "email": "developers@ticketmatic.com",
31 "firstname": "John",
32 "image": "https://www.ticketmatic.com/image.jpg",
33 "languagecode": "NL",
34 "lastname": "Doe",
35 "lookup": {
36 "contacts": []
37 },
38 "middlename": "K",
39 "optins": [
40 {
41 "id": 29323,
42 "info": {
43 "method": "boxoffice",
44 "remarks": "The customer accepted the terms."
45 },
46 "optinid": 827,
47 "status": 7602
48 }
49 ],
50 "organizationfunction": "Director of ticketing",
51 "phonenumbers": [
52 {
53 "id": 123,
54 "typeid": 3,
55 "customerid": 9364924,
56 "number": "+3216881940",
57 "type": "Home"
58 }
59 ],
60 "relationships": [
61 {
62 "id": 1,
63 "typeid": 47001,
64 "childcontactid": 10000,
65 "parentcontactid": 9364924
66 }
67 ],
68 "relationtypes": [ 1, 2 ],
69 "sendmail": false,
70 "sex": "M",
71 "status": "incomplete",
72 "subscribed": false,
73 "vatnumber": "BE123456789",
74 "isdeleted": false,
75 "createdts": "2014-09-26 15:24:36",
76 "lastupdatets": "2014-09-26 15:24:36"
77}