Social Profiles, E-mail Address, URLs, Phone Numbers, and Addresses are similar minor objects that contacts and companies have.
Though they are similar, they are separate types because we apply different restrictions in each case.
Each entry has a label and an ordering. Lists are returned sorted by ordering, with entries whose ordering is 0 (the default) listed last.
When updating a contact or company, sending a list replaces all of its entries. To change only some entries, send {"add": [...], "remove": [...]} instead. Entries are matched by address for e-mail addresses, url for URLs, number for phone numbers, service and username for social profiles, and all address fields for addresses.
Social Profiles
Social profiles are links to social networks (like Facebook, Twitter, or LinkedIn) and instant messaging addresses (like Skype, AIM, Jabber).
| Attribute Name | Type | Description | Attributes |
|---|---|---|---|
label | string | A Label giving context to the social profile, e.g. "Work". Created if it does not exist (max 32 characters) | Read-Write Non-null Required |
service | string | Service name. Known services are AIM, Jabber, MSN, Yahoo, ICQ, Twitter, Facebook, LinkedIn, Skype, GaduGadu, Google Talk, QQ, Flickr, MySpace, Sina Weibo, Tencent Weibo, Yelp and GameCenter. Any other name is stored as a custom service (max 128 characters) | Read-Write Non-null Required |
username | string | Username on the service (max 1024 characters) | Read-Write Non-null Required |
ordering | integer | Position in the list. Entries with 0 (the default) are listed last | Read-Write Non-null Default value is 0 |
E-mail Addresses
| Attribute Name | Type | Description | Attributes |
|---|---|---|---|
label | string | A Label giving context to the e-mail address, e.g. "Work". Created if it does not exist (max 32 characters) | Read-Write Non-null Required |
address | string | The email address (max 1024 characters) | Read-Write Non-null Required |
note | string | Note about the email address (max 1024 characters) | Read-Write Nullable |
ordering | integer | Position in the list. Entries with 0 (the default) are listed last | Read-Write Non-null Default value is 0 |
URLs
| Attribute Name | Type | Description | Attributes |
|---|---|---|---|
label | string | A Label giving context to the URL, e.g. "Work". Created if it does not exist (max 32 characters) | Read-Write Non-null Required |
url | string | A URI, which must be RFC 3986 compliant (max 1024 characters) | Read-Write Non-null Required |
note | string | Note about the URL (max 1024 characters) | Read-Write Nullable |
ordering | integer | Position in the list. Entries with 0 (the default) are listed last | Read-Write Non-null Default value is 0 |
Phone Numbers
| Attribute Name | Type | Description | Attributes |
|---|---|---|---|
label | string | A Label giving context to the phone number, e.g. "Work". Created if it does not exist (max 32 characters) | Read-Write Non-null Required |
format | string | E.164 or free-form. See Phone number formatting | Read-Write Non-null Detected automatically when omitted |
number | string | The phone number (max 32 characters) | Read-Write Non-null Required |
note | string | Note about the phone number | Read-Write Nullable |
ordering | integer | Position in the list. Entries with 0 (the default) are listed last | Read-Write Non-null Default value is 0 |
Phone number formatting
E.164 is the preferred format: +, the country code, then the subscriber number including the area code, e.g. +18005550123.
- When
formatisE.164, the number must be a valid E.164 number. It is stored and returned in international format, e.g.+1 800-555-0123. - When
formatisfree-form, the number is stored as sent and Daylite won't attempt to parse it. Use this for numbers that can't be expressed in E.164. - When
formatis omitted, it is set toE.164if the number is valid E.164, andfree-formotherwise.
Addresses
| Attribute Name | Type | Description | Attributes |
|---|---|---|---|
label | string | A Label giving context to the address, e.g. "Work". Created if it does not exist (max 32 characters) | Read-Write Non-null Required |
street | string | Street number and name (max 128 characters) | Read-Write Nullable |
city | string | City, town, village, etc. (max 128 characters) | Read-Write Nullable |
state | string | State, province, county, etc. (max 128 characters) | Read-Write Nullable |
postal_code | string | Postal or ZIP code (max 32 characters) | Read-Write Nullable |
country | string | Country name (max 128 characters) | Read-Write Nullable |
note | string | Additional details about the address (max 2048 characters) | Read-Write Nullable |
ordering | integer | Position in the list. Entries with 0 (the default) are listed last | Read-Write Non-null Default value is 0 |
ValidationEven though all address components are optional, a valid address requires at least one of
street,city,state,postal_code, orcountryto be a non-empty string.