Social Profiles, E-mail Address, URLs, Phone Numbers, and Addresses

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 NameTypeDescriptionAttributes
labelstringA Label giving context to the social profile, e.g. "Work". Created if it does not exist (max 32 characters)Read-Write
Non-null
Required
servicestringService 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
usernamestringUsername on the service (max 1024 characters)Read-Write
Non-null
Required
orderingintegerPosition in the list. Entries with 0 (the default) are listed lastRead-Write
Non-null
Default value is 0

E-mail Addresses

Attribute NameTypeDescriptionAttributes
labelstringA 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
addressstringThe email address (max 1024 characters)Read-Write
Non-null
Required
notestringNote about the email address (max 1024 characters)Read-Write
Nullable
orderingintegerPosition in the list. Entries with 0 (the default) are listed lastRead-Write
Non-null
Default value is 0

URLs

Attribute NameTypeDescriptionAttributes
labelstringA Label giving context to the URL, e.g. "Work". Created if it does not exist (max 32 characters)Read-Write
Non-null
Required
urlstringA URI, which must be RFC 3986 compliant (max 1024 characters)Read-Write
Non-null
Required
notestringNote about the URL (max 1024 characters)Read-Write
Nullable
orderingintegerPosition in the list. Entries with 0 (the default) are listed lastRead-Write
Non-null
Default value is 0

Phone Numbers

Attribute NameTypeDescriptionAttributes
labelstringA Label giving context to the phone number, e.g. "Work". Created if it does not exist (max 32 characters)Read-Write
Non-null
Required
formatstringE.164 or free-form. See Phone number formattingRead-Write
Non-null
Detected automatically when omitted
numberstringThe phone number (max 32 characters)Read-Write
Non-null
Required
notestringNote about the phone numberRead-Write
Nullable
orderingintegerPosition in the list. Entries with 0 (the default) are listed lastRead-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 format is E.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 format is free-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 format is omitted, it is set to E.164 if the number is valid E.164, and free-form otherwise.

Addresses

Attribute NameTypeDescriptionAttributes
labelstringA Label giving context to the address, e.g. "Work". Created if it does not exist (max 32 characters)Read-Write
Non-null
Required
streetstringStreet number and name (max 128 characters)Read-Write
Nullable
citystringCity, town, village, etc. (max 128 characters)Read-Write
Nullable
statestringState, province, county, etc. (max 128 characters)Read-Write
Nullable
postal_codestringPostal or ZIP code (max 32 characters)Read-Write
Nullable
countrystringCountry name (max 128 characters)Read-Write
Nullable
notestringAdditional details about the address (max 2048 characters)Read-Write
Nullable
orderingintegerPosition in the list. Entries with 0 (the default) are listed lastRead-Write
Non-null
Default value is 0
📘

Validation

Even though all address components are optional, a valid address requires at least one of street, city, state, postal_code, or country to be a non-empty string.