The organisation data model defines every field associated with an organisation. When an organisation is imported into Connect, the connector populates these fields. When an organisation is exported from Connect, each field is mapped to its counterpart in the external platform.
The data model gives insight into the data saved with each organisation and what data is available for rule building.
In this article you will learn more about:
Data model
| Field | Description | Example of input | Required |
|---|---|---|---|
| ID | Organisation ID in Spotler Connect | "571f3442-5321-45a5-96bc-3c445edcd498" | |
| SourceNumber | Organisation ID in source platform* | "100022992" | Yes |
| Status | Organisation status | "Active" | |
| Anonymized | Anonymization status | "null" | |
| Source | ID of source platform | "7ccc916c-8f1d-4e46-8310-685d03d7ed99" | Yes |
| Name | Organisation name | Microsoft | Yes |
| Type | Type of organisation. Currently available 1 or 2 (in progress) | "1" | |
| Domain | Organisation domain | "Microsoft.com" | Yes |
| DomainHash | Hash of domain | "2a9a9a49916839e16bb…" | |
| Address.FirstName | First name in address | "Anne" | |
| Address.LastName | Last name in address | "De Vries" | |
| Address.Email | Email address in address | "vries@microsoft.com" | |
| Address.EmailHash | Hash of email address | "2a9a9a49916839e16bb…" | |
| Address.Phone | Phone number in address | "+4475000923847" | |
| Address.CompanyName | Organisation name in address | "Microsoft" | |
| Address.Department | Department in address | "Sales" | |
| Address.ToAttentionOf | Attention field in address | "null" | |
| Address.Country | Country in address, ISO-code | "NL" | |
| Address.Region | Region in address | "Zuid Holland" | |
| Address/RegionCode | Region in address, ISO-code | "ZH" | |
| Address.City | City in address | "Amsterdam" | |
| Address.ZipCode | Zipcode in address | "1012 RJ" | |
| Address.Street | Street in address | ||
| Address.Housenumber | Housenumber in address | "147" | |
| Address.Housenumber Extension | Housenumber extension in address | "null" | |
| Email address associated with organisation | "info@microsoft.com" | ||
| EmailHash | Hash of Email address | "2a9a9a49916839e16bb…" | |
| Description | Description of organisation | "null" | |
| Note | Note about organisation | "null" | |
| Meta | Meta data | differs per connector |
API documentation
If you are looking into using this data model for your own connector, please visit the API documentation for Spotler Connect.