Contacts
The Contacts API is used to manage a site's contacts. Learn more.
Additional information about this section
Perform actions on an object
- createContact( )
Creates a new contact.
- appendOrCreateContact( )
Appends contactInfo to an existing contact or creates a new contact if it doesn't already exist.
- updateContact( )
Updates a contact's properties.
- labelContact( )
Adds labels to a contact.
- unlabelContact( )
Removes labels from a contact.
- getContact( )
Retrieves a contact.
- queryContacts( )
Creates a query to retrieve a list of contacts.
- deleteContact( )
Deletes a contact who is not a site member or contributor.
- findOrCreateLabel( )
Retrieves a label with a given name, or creates one if it doesn't exist.
- getLabel( )
Retrieves a label.
- queryLabels( )
Creates a query to retrieve a list of labels.
- renameLabel( )
Renames a label.
- deleteLabel( )
Deletes a label from the site and removes it from contacts it applies to.
- findOrCreateExtendedField( )
Retrieves a custom field with a given name, or creates one if it doesn't exist.
- getExtendedField( )
Retrieves an extended field.
- queryExtendedFields( )
Creates a query to retrieve a list of extended fields.
- renameExtendedField( )
Renames an extended field.
- deleteExtendedField( )
Deletes an extended field.
- ContactsQueryBuilder
Contains functionality for refining a contacts query.
- ContactsQueryResult
The results of a contacts query, containing the retrieved items.
- LabelsQueryBuilder
Contains functionality for refining a labels query.
- LabelsQueryResult
The results of a contacts query, containing the retrieved items.
- ExtendedFieldsQueryBuilder
Contains functionality for refining an extended fields query.
- ExtendedFieldsQueryResult
The results of a contacts query, containing the retrieved items.