Google Contacts

Overview

Events

• New or Updated Contact

  New or Updated Contact

  Monitors Google Contacts for updates and runs the Flow any time there is a new or updated contact.

  Output Fields

  Note: Many of these fields are often unavailable and get assigned a null/empty value.

  • Contact ID (text): The unique ID for the contact that was added or updated.
  • Title (text): If a title, such as “Mr.”
  • Subject (text): The subject for the contact.
  • Updated At (text): The date and time the contact that was added or updated.
  • Full Name (text): The full name, including title, of the contact.
  • Family Name (text): The last name of the contact.
  • Given Name (text): The first name.
  • Gender (text): The gender.
  • Occupation (text): The occupation.
  • Billing Information (text): The billing information.
  • Directory Server (text): The directory server associated with the contact.
  • Birthday (text): The contact’s birthday in the format yyyy-mm-dd (e.g. “1999-08-15”)
  • Nickname (text): The contact’s nickname.
  • Extended Properties (object): An object with keys and values for each custom property added for the contact. Use the Object functions such as Get or Get Multiple to access individual values.

  NOTE: The following output fields are lists of objects since a Google Contact may have, for example, many phone numbers, emails, websites, etc. The List Functions can help your process a list, e.g. you can use a At card to choose the first phone number in the list or a Filter card to pick out the phone number where the Primary? field is set to True.

  • Phone Numbers (list of object): The list of phone numbers for the contact, where each phone number is an object with the following fields:
    • Phone Number (text)
    • Label (text): if a custom type is provided, it appears here and Type is empty
    • Type (text): type of phone number, e.g. “HOME” or “MOBILE”
    • Primary? (true/false): indicates if this is marked as the primary number to use
  • Email Addresses (list of object): The list of email addresses, where each email has the following fields:
    • Email Address (text)
    • Display Name (text)
    • Label (text): if a custom type is provided, it appears here and Type is empty
    • Type (text): type of email address, e.g. “HOME” or “WORK”
    • Primary? (true/false): indicates if this is marked as the primary email to use
  • Postal Addresses (list of object): The list of mailing addresses, where each address has the following fields:
    • Street (text)
    • City (text)
    • Region (text)
    • Neighborhood (text)
    • Postal Code (text)
    • PO Box (text)
    • Country (text)
    • Type (text): type of address, e.g. “HOME” or “WORK”
    • Label (text): if a custom type is provided, it appears here and Type is empty
    • Primary? (true/false):  indicates if this is marked as the primary address to use
  • Organizations (list of object): The list of companies or organizations the contact is associated with, where each organization has the following fields:
    • Organization Name (text)
    • Job Title (text)
    • Job Description (text)
    • Department (text)
    • Label (text)
  • Websites (list of object): The list of websites for the contact where each has the following fields:
    • Primary? (true/false):  indicates if this is marked as the primary website for the contact
    • Link (text): URL to the website
    • Label (text)
  • Languages (list of object): The list of languages associated with the contact where each has the following fields:
    • Language Code (text): language code that conforms to IETF BCP 47.
    • Label (text)
  • External IDs (list of object): The list of IDs for the contact in an external system where each has:
    • Value (text): the ID
    • Label (text)
    • Type (text)
  • Calendars (list of object): The list of calendars for the contact, where each has the following fields:
    • Calendar Link (text):
    • Label (text): if a custom type is provided, it appears here and Type is empty
    • Type (text): type of email address, e.g. “HOME” or “WORK”
    • Primary? (true/false): indicates if this is marked as the primary email to use
  • Context
    • Execution ID (text): The execution ID of the Flow that ran for this contact. Can be used for error handling purposes.

Actions

• Add to Contact

  Add to Contact

  Google Contacts have several fields that can be a list of values, e.g. a list of email addresses. Use this action to add an additional email address, phone number, postal address, organization, website, language, external ID, or calendar to a contact.

  Options

  • Field (dropdown list): Choose what you want to add to the contact: email address, phone number, postal address, organization, website, language, external ID, or calendar.

  Input Fields

  • Contact ID (text): The unique ID for the contact you want to modify. You can get this ID as the output from another Google Contact card such as Search Contacts.

  NOTE: The additional input fields will vary depending on what _Field_ type you choose.

  For Email Address:

  • Email Address (text)
  • Display Name (text)
  • Type (text): type of email, e.g. “Work”
  • Label (text): a custom label (if you use this field, a _Type_ must be blank)
  • Primary? (true/false): indicates if this is marked as the primary email to use

  For Phone Number:

  • Phone Number (text)
  • Type (text): type of phone number, e.g. “Home”
  • Label (text): a custom label (if you use this field, a _Type_ must be blank)
  • Primary? (true/false): indicates if this is marked as the primary number to use

  For Postal Address:

  • Label (text): a custom label (if you use this field, a _Type_ must not be selected)
  • Street (text)
  • City (text)
  • Region (text): such as State (e.g. “NY”) or Province
  • Neighborhood (text)
  • Post Code (text)
  • PO Box (text)
  • Country (text)
  • Type (text): type of address, e.g. “Home” or “Work”
  • Primary? (true/false):  indicates if this is marked as the primary address to use

  For Organization:

  • Label (text)
  • Organization Name (text)
  • Job Title (text)
  • Job Description (text)
  • Department (text)
  • Primary? (true/false):  indicates if this is marked as the primary organization

  For Website:

  • Primary? (true/false):  indicates if this is marked as the primary website for the contact
  • Link (text): URL to the website
  • Label (text): a custom label (if you use this field, a _Type_ must not be selected)
  • Type (text): type of website, e.g. “Home Page” or “Blog”

  For Language:

  • Language Code (text): language code that conforms to IETF BCP 47.
  • Label (text)

  For External ID:

  • Value (text): the ID
  • Label (text): a custom label (if you use this field, a _Type_ must not be selected)
  • Type (text): type of ID, e.g. Account, Customer, Network, or Organization.

  For Calendar:

  • Calendar Link (text):
  • Label (text): a custom label (if you use this field, a _Type_ must not be selected)
  • Type (text): type of calendar, e.g. “Home”, “Work” or “Free/Busy”
  • Primary? (true/false): indicates if this is marked as the primary calendar to use

  Output Fields

  None

• Create Contact

  Create Contact

  Creates a new contact.

  Input Fields

  Note: Many of these fields are optional and can be left blank.

  • Title (text): If a title, such as “Mr.”
  • Full Name (text): The full name, including optional title, of the contact.
  • Family Name (text): Last name.
  • Given Name (text): First name.
  • Gender (text): Male, Female, or Other
  • Birthday (text): The contact’s birthday in the format yyyy-mm-dd (e.g. “1999-08-15”)
  • Subject (text)
  • Occupation (text)
  • Nickname (text)
  • Billing Information (text)
  • Directory Server (text): The directory server associated with the contact.

  NOTE: The following input fields allow you to create the first of what can be many items associated with a contact, e.g. a single phone number. To add additional items (e.g. more phone numbers) use Add to Contact cards.

  • Phone Number
    • Phone Number (text)
    • Type (dropdown): type of phone number, e.g. “Home”
    • Label (text): a custom description (if you use this field, a _Type_ must not be selected)
    • Primary? (true/false): indicates if this is marked as the primary number to use
  • Email Address
    • Email Address (text)
    • Display Name (text)
    • Type (dropdown): type of email, e.g. “Work”
    • Label (text): a custom description (if you use this field, a _Type_ must not be selected)
    • Primary? (true/false): indicates if this is marked as the primary email to use
  • Postal Address
    • Label (text): a custom description (if you use this field, a _Type_ must not be selected)
    • Street (text)
    • City (text)
    • Region (text): such as State (e.g. “NY”) or Province
    • Neighborhood (text)
    • Post Code (text)
    • PO Box (text)
    • Country (text)
    • Type (text): type of address, e.g. “Home” or “Work”
    • Primary? (true/false):  indicates if this is marked as the primary address to use
  • Organization
    • Label (text)
    • Organization Name (text)
    • Job Title (text)
    • Job Description (text)
    • Department (text)
    • Primary? (true/false):  indicates if this is marked as the primary organization
  • Website
    • Primary? (true/false):  indicates if this is marked as the primary website for the contact
    • Link (text): URL to the website
    • Label (text): a custom description (if you use this field, a _Type_ must not be selected)
    • Type (dropdown): type of website, e.g. “Home Page” or “Blog”
  • Language
    • Language Code (text): language code that conforms to IETF BCP 47.
    • Label (text)
  • Calendar
    • Calendar Link (text):
    • Label (text): a custom description (if you use this field, a _Type_ must not be selected)
    • Type (dropdown): type of calendar, e.g. “Home”, “Work” or “Free/Busy”
    • Primary? (true/false): indicates if this is marked as the primary calendar to use
  • External ID
    • Value (text): the ID
    • Label (text): a custom description (if you use this field, a _Type_ must not be selected)
    • Type (dropdown): type of ID, e.g. Account, Customer, Network, or Organization.
  • Extended Properties: Allows you to add custom fields to a contact. Create as many inputs, providing name, type, and value for each.

  Output Fields

  • Contact ID (text): The unique ID for the contact that was created. You’ll need this ID to access the contact for additional actions, such as Add to Contact to add additional phone numbers, addresses, etc. to the contact.

• Delete Contact

  Using the ID of a contact you intend to delete and remove from your Google Contacts directory.

  Input Fields

  • Contact ID (text): The unique ID for the contact that you intend to delete.

  Output Fields

  • Deleted ID (text): The unique ID for the contact that has been deleted.

• Read All Contacts

  Using this action will return every contact within your Google Contact Directory. The key is that the entire output will be a list that will need to be processed likely using Object and/or List functions. Some of the more detailed ones are described below. A couple key actions that can often be used to help get to the contacts you intend to deal with immediately are Filter and For Each.

  Output Fields

  Note: Many of these fields are often unavailable and get assigned a null/empty value. Contacts (list of text and objects)

  • Contact ID (text): The unique ID for the contact that you intend to read and get information from.
  • Title (text): If a title, such as “Mr.”
  • Subject (text): The subject for the contact.
  • Updated At (text): The date and time the contact that was added or updated.
  • Full Name (text): The full name, including title, of the contact.
  • Family Name (text): The last name of the contact.
  • Given Name (text): The first name.
  • Gender (text): The gender.
  • Occupation (text): The occupation.
  • Billing Information (text): The billing information.
  • Directory Server (text): The directory server associated with the contact.
  • Birthday (text): The contact’s birthday in the format yyyy-mm-dd (e.g. “1999-08-15”)
  • Nickname (text): The contact’s nickname.
  • Extended Properties (object): An object with keys and values for each custom property added for the contact. Use the Object functions such as Get or Get Multiple to access individual values.

  NOTE: The following output fields are lists of objects since a Google Contact may have, for example, many phone numbers, emails, websites, etc. The List Functions can help your process a list, e.g. you can use a At card to choose the first phone number in the list or a Filter card to pick out the phone number where the Primary? field is set to True.

  • Phone Numbers (list of object): The list of phone numbers for the contact, where each phone number is an object with the following fields:
    • Phone Number (text)
    • Label (text): if a custom type is provided, it appears here and Type is empty
    • Type (text): type of phone number, e.g. “HOME” or “MOBILE”
    • Primary? (true/false): indicates if this is marked as the primary number to use
  • Email Addresses (list of object): The list of email addresses, where each email has the following fields:
    • Email Address (text)
    • Display Name (text)
    • Label (text): if a custom type is provided, it appears here and Type is empty
    • Type (text): type of email address, e.g. “HOME” or “WORK”
    • Primary? (true/false): indicates if this is marked as the primary email to use
  • Postal Addresses (list of object): The list of mailing addresses, where each address has the following fields:
    • Street (text)
    • City (text)
    • Region (text)
    • Neighborhood (text)
    • Postal Code (text)
    • PO Box (text)
    • Country (text)
    • Type (text): type of address, e.g. “HOME” or “WORK”
    • Label (text): if a custom type is provided, it appears here and Type is empty
    • Primary? (true/false):  indicates if this is marked as the primary address to use
  • Organizations (list of object): The list of companies or organizations the contact is associated with, where each organization has the following fields:
    • Organization Name (text)
    • Job Title (text)
    • Job Description (text)
    • Department (text)
    • Label (text)
  • Websites (list of object): The list of websites for the contact where each has the following fields:
    • Primary? (true/false):  indicates if this is marked as the primary website for the contact
    • Link (text): URL to the website
    • Label (text)
  • Languages (list of object): The list of languages associated with the contact where each has the following fields:
    • Language Code (text): language code that conforms to IETF BCP 47.
    • Label (text)
  • External IDs (list of object): The list of IDs for the contact in an external system where each has:
    • Value (text): the ID
    • Label (text)
    • Type (text)
  • Calendars (list of object): The list of calendars for the contact, where each has the following fields:
    • Calendar Link (text):
    • Label (text): if a custom type is provided, it appears here and Type is empty
    • Type (text): type of email address, e.g. “HOME” or “WORK”
    • Primary? (true/false): indicates if this is marked as the primary email to use
  • Context
    • Execution ID (text): The execution ID of the Flow that ran for this contact. Can be used for error handling purposes.

• Read Contact

  Using the ID of a contact you will be able to read and retrieve all attributes about that record.

  Input Fields

  • Contact ID (text): The unique ID for the contact that you intend to read and get information from.

  Output Fields

  Note: Many of these fields are often unavailable and get assigned a null/empty value.

  • Title (text): If a title, such as “Mr.”
  • Subject (text): The subject for the contact.
  • Updated At (text): The date and time the contact that was added or updated.
  • Full Name (text): The full name, including title, of the contact.
  • Family Name (text): The last name of the contact.
  • Given Name (text): The first name.
  • Gender (text): The gender.
  • Occupation (text): The occupation.
  • Billing Information (text): The billing information.
  • Directory Server (text): The directory server associated with the contact.
  • Birthday (text): The contact’s birthday in the format yyyy-mm-dd (e.g. “1999-08-15”)
  • Nickname (text): The contact’s nickname.
  • Extended Properties (object): An object with keys and values for each custom property added for the contact. Use the Object functions such as Get or Get Multiple to access individual values.

  NOTE: The following output fields are lists of objects since a Google Contact may have, for example, many phone numbers, emails, websites, etc. The List Functions can help your process a list, e.g. you can use a At card to choose the first phone number in the list or a Filter card to pick out the phone number where the Primary? field is set to True.

  • Phone Numbers (list of object): The list of phone numbers for the contact, where each phone number is an object with the following fields:
    • Phone Number (text)
    • Label (text): if a custom type is provided, it appears here and Type is empty
    • Type (text): type of phone number, e.g. “HOME” or “MOBILE”
    • Primary? (true/false): indicates if this is marked as the primary number to use
  • Email Addresses (list of object): The list of email addresses, where each email has the following fields:
    • Email Address (text)
    • Display Name (text)
    • Label (text): if a custom type is provided, it appears here and Type is empty
    • Type (text): type of email address, e.g. “HOME” or “WORK”
    • Primary? (true/false): indicates if this is marked as the primary email to use
  • Postal Addresses (list of object): The list of mailing addresses, where each address has the following fields:
    • Street (text)
    • City (text)
    • Region (text)
    • Neighborhood (text)
    • Postal Code (text)
    • PO Box (text)
    • Country (text)
    • Type (text): type of address, e.g. “HOME” or “WORK”
    • Label (text): if a custom type is provided, it appears here and Type is empty
    • Primary? (true/false):  indicates if this is marked as the primary address to use
  • Organizations (list of object): The list of companies or organizations the contact is associated with, where each organization has the following fields:
    • Organization Name (text)
    • Job Title (text)
    • Job Description (text)
    • Department (text)
    • Label (text)
  • Websites (list of object): The list of websites for the contact where each has the following fields:
    • Primary? (true/false):  indicates if this is marked as the primary website for the contact
    • Link (text): URL to the website
    • Label (text)
  • Languages (list of object): The list of languages associated with the contact where each has the following fields:
    • Language Code (text): language code that conforms to IETF BCP 47.
    • Label (text)
  • External IDs (list of object): The list of IDs for the contact in an external system where each has:
    • Value (text): the ID
    • Label (text)
    • Type (text)
  • Calendars (list of object): The list of calendars for the contact, where each has the following fields:
    • Calendar Link (text):
    • Label (text): if a custom type is provided, it appears here and Type is empty
    • Type (text): type of email address, e.g. “HOME” or “WORK”
    • Primary? (true/false): indicates if this is marked as the primary email to use
  • Context
    • Execution ID (text): The execution ID of the Flow that ran for this contact. Can be used for error handling purposes.

• Remove from Contact

  Remove from Contact

  Google Contacts have several fields that can be a list of values, e.g. a list of email addresses. Use this action to remove an email address, phone number, postal address, organization, website, language, external ID, or calendar from a contact.

  Options

  • Field (dropdown list): Choose what you want to remove from the contact: email address, phone number, postal address, organization, website, language, external ID, or calendar.

  Input Fields

  • Contact ID (text): The unique ID for the contact you want to modify. You can get this ID as the output from another Google Contact card such as Search Contacts.
  • Label (text): the label of which item to remove (if you use this field, _Type_ must be blank)
  • Type (text): the selected type to remove (if no custom label), e.g. “Work” or “Home” for an email, phone number or address.

  Output Fields

  None

• SearchContacts

  Search Contacts

  Finds contacts that match a provided search criteria.

  Options

  • Search For (dropdown): choose to search for “First matching contact” or “All matching contacts.”

  Input Fields

  Returns the first or all contacts that match the specified criteria. The matching ignores case and will match any part of the value. For example, searching for Full Name “andy” would return contacts with the name “Andy” or “Sandy.” If you were to also enter in an Organization Name, you’d only get back results that match both the Full Name and the Organization Name. The fields you can search in include:

  • Email Address (text)
  • Title (text)
  • Full Name (text)
  • Given Name (text): aka First Name.
  • Family Name (text): aka Last Name.
  • Nickname (text)
  • Birthday (text)
  • Subject (text)
  • Occupation (text)
  • Phone Number (text)
  • Organization Name (text)
  • Website Link (text)
  • Calendar Link (text)
  • External ID (text)

  Output Fields

  If chose to search for “First matching contact” the output is a single ID:

  • Contact ID (text): the unique IDs for the first contact that meets the search criteria.

  If chose to search for “All matching contacts,” the output is a list:

  • Contact IDs (list of text): a list of the unique IDs for the contacts that meet the search criteria, or an empty list if there are no matches.

  To work with items in a list, see the available List Functions that can follow in your Flow, such as For Each to process each of the contacts one at a time. You can pass the Contact ID to other Google Contact actions such as Read Contact or Delete Contact.

• Update Contact

  Updates an existing contact.

  Input Fields

  Updated By

  • Contact ID (text): The unique ID for the contact you want to modify. You can get this ID as the output from another Google Contact card such as Search Contacts.

  Basic Info

  • Title (text): If a title, such as “Mr.”
  • Full Name (text): The full name, including optional title, of the contact.
  • Family Name (text): Last name.
  • Given Name (text): First name.
  • Gender (text): Male, Female, or Other
  • Birthday (text): The contact’s birthday in the format yyyy-mm-dd (e.g. “1999-08-15”)
  • Subject (text)
  • Occupation (text)
  • Nickname (text)
  • Billing Information (text)
  • Directory Server (text): The directory server associated with the contact.

  Output Fields

  • Contact ID (text): The unique ID for the contact that was updated.