Contacts
Contacts represent the resource associated with mobile users or contacts acquired via Experiences.
Contact object: example
The Contact object may differ depending on the specific API. You can explore the Contact object in the definition of each API endpoint.
{
"cid":"string",
"title":"string",
"firstName":"string",
"lastName":"string",
"gender":"string",
"birthDate":"string",
"birthDay":"string",
"age":"string",
"country":"string",
"zipCode":"string",
"created":"string",
"modified":"string",
"email":"string",
"emailVerified":true,
"phone":"string",
"phoneVerified":true,
"signupMethod":"string",
"externalIdentityId":"string",
"username":"string",
"locked":true,
"organizationCid":"string",
"locationCid":"string",
"system":"string",
"enabled":true,
"type":"string",
"locationName":"string",
"personalId":"string",
"externalSource":"string",
"lastLogin":"string",
"segmentCids":"string",
"logins":0,
"policies":[
{
"name":"string",
"accepted":true
}
],
"segments":[
{
"cid":"string",
"name":"string"
}
],
"extId":{
"id":"string",
"prop1":"string",
"prop2":"string"
},
"metrics":{
"frequencyMonthlyVisit":0,
"compassTopLocation":"string",
"compassTopLocationCount":0,
"topFrequencyBuckets":"string",
"lastVisitVenue":"string",
"prefVisitWDay":"string",
"lastVisitDateUtc":"string",
"avgVisitLength":0,
"countVisitedLocations":0,
"prefVisitTimebucket":"string",
"prefVisitTimeHour":"string",
"lastVisitDateBusiness":"string",
"countTotalVisits":0,
"conversionRate":0,
"avgDaysBetweenVisits":0
}
}
get
https://explore.cloud4wi.com/
/v2/customers/organizations/{cid}
List all the Contacts of an organization matching the search parameters
get
https://explore.cloud4wi.com/
/v2/customers/{cid}
Get a Contact
get
https://explore.cloud4wi.com/
/v2/customers/{cid}/events
List location Events of a Contact
get
https://explore.cloud4wi.com/
/v2/customers/{cid}/devices
List all devices of a Contact
put
https://explore.cloud4wi.com/
/v1/customers/{cid}/policies
Update the opt-ins of a Contact
delete
https://explore.cloud4wi.com/
/v1/customers/{cid}
Delete a Contact
get
https://explore.cloud4wi.com/
/v2/customers/{cid}/accountings
List all WiFi Connections of a Contact
Example of Contact object returned by the endpoint https://explore.cloud4wi.com//v2/customers/organizations/{cid}
{
"generated":"2022-11-15T15:45:04Z",
"totalCount":1,
"count":1,
"customers":[
{
"segments":[
{
"cid":"12d1f8713a1fecb953bcc64220813bc6",
"name":"Loyal Customer"
}
],
"cid":"f4c6be2cebc56bf4b8a16a2d463d5b60",
"title":null,
"firstName":"Ivan",
"lastName":"Muccini",
"gender":"male",
"birthDate":"1982",
"birthDay":"01-29",
"age":38,
"country":"us",
"zipCode":null,
"created":"2022-07-21T17:58:35Z",
"createdBusiness":"2022-07-21T17:58:35Z",
"modified":"2022-11-15T05:19:43Z",
"email":"[email protected]",
"emailVerified":false,
"phone":"+14156264284",
"phoneNumber":"4156264284",
"phonePrefix":"+1",
"phoneVerified":false,
"signupMethod":"passthrough",
"externalIdentityId":null,
"username":"RG1DXHXHMRTW",
"locked":false,
"organizationCid":"155d60f21dc1938562900a0e201d54f6",
"locationCid":"ff808081803ff92a01820195deb26263",
"system":"mobileapp",
"enabled":true,
"type":"guest",
"locationName":"hiddden_SECUREWIFI.IO",
"personalId":null,
"externalSource":"Cloud4wi",
"policies":[
{
"name":"termsOfUse",
"accepted":true,
"date":"2022-07-21T17:58:35.000Z",
"version":"default"
},
{
"name":"privacy",
"accepted":true,
"date":"2022-07-21T17:58:35.000Z",
"version":"default"
},
{
"name":"mktgCommunications",
"accepted":true,
"date":"2022-07-21T17:58:35.000Z",
"version":"default"
},
{
"name":"profiling",
"accepted":false,
"date":"2020-10-26T14:18:21.000Z",
"version":"1.00"
}
],
"lastLogin":"2022-08-02T14:48:57.000Z",
"logins":182,
"metrics":{
"frequencyMonthlyVisit":3.0897396143865636,
"compassTopLocation":"ff808081803ff92a01821d4cfd856805",
"compassTopLocationCount":12,
"topFrequencyBuckets":"daily",
"lastVisitVenue":"ff808081803ff92a01821d4cfd856805",
"prefVisitWDay":2,
"lastVisitDateUtc":"2022-08-02T14:54:36Z",
"avgVisitLength":461.3333333333333,
"countVisitedLocations":1,
"prefVisitTimebucket":"afternoon",
"prefVisitTimeHour":"15",
"lastVisitDateBusiness":"2022-08-02T07:54:36Z",
"countTotalVisits":12,
"conversionRate":1,
"avgDaysBetweenVisits":1.0909090909090908
},
"emailValid":null,
"language":"it",
"splashLanguage":"it",
"genericCustomField":[
{
"key":"loyalty_card",
"value":"9500000012143687"
}
],
"extId":{
}
}
]
}
Last modified 2mo ago