Open contact form
  • 18 May 2022
  • 1 Minute to read
  • Dark
  • PDF

Open contact form

  • Dark
  • PDF

Opens the native form to add a new contact.

Any fields that are defined in the New contact object are prefilled in the form.

Once the contact has been added, the first output is triggered.

If the user cancels the form, the second output is triggered.

If there is an error, the third output is triggered.

If the user hasn't given permission to access contacts, they will be requested automatically.

Input arguments

Label Key Type Required? Default Description
New contact contact Object Yes New contact to prefill the contact form with.

Output arguments

Number of outputs: 3

Label Key Type Description
New contact contact Object New contact to add to the contacts list.
  • Record ID
contact.recordID String System ID for the contact record
  • Company String
  • Email addresses
contact.emailAddresses Array
  • Family name
contact.familyName String
  • Given name
contact.givenName String
  • Middle name
contact.middleName String
  • Job title
contact.jobTitle String
  • Note
contact.note String Android-only. Text note attached to the contact.
  • URL addresses
contact.urlAddresses Array
  • Phone numbers
contact.phoneNumbers Array
  • Has thumbnail
contact.hasThumbnail Boolean
  • Thumbnail path
contact.thumbnailPath String
  • URL addresses
contact.postalAddresses Array
  • Birthday
contact.birthday Object


No events.


Label Code Description
Unknown error unknown Thrown if an unknown error occurred while getting the contacts.

Was this article helpful?

What's Next