Cvent Contacts API
A contact is a record in your account’s address book that represents an individual. The data stored within these records includes personal information, group memberships, and historical data on event attendance. Contact APIs will allow you to get contact information, track updates to contact information, and create contacts.
Operations 28
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“How do I set up a new group to organize contacts, like a VIP list?”
“Can I give a contact group a short description and a note when creating it?”
Tell an agent
Create a contact group named {name} with ID {id}.
Create contact group {name} described as {shortDescription}, using ID {id}.
Ask an LLM
“What contact groups do I have in my Cvent address book?”
“Can I list only contact groups created after a certain date?”
Tell an agent
List all my contact groups.
List contact groups matching {filter}.
Ask an LLM
“How do I look up one contact group's details?”
“What type and description does a given contact group have?”
Tell an agent
Get contact group {id}.
Show the details of contact group {id}.
Ask an LLM
“How do I rename an existing contact group?”
“Can I change the description or note on a contact group?”
Tell an agent
Rename contact group {id} to {name}.
Update the description of contact group {id} to {description}.
Ask an LLM
“How do I delete a contact group I no longer use?”
“Does deleting a contact group get rid of the group itself permanently?”
Tell an agent destructive · confirm first
Delete contact group {id}.
Remove the contact group {id} from my account.
Ask an LLM
“Which contacts belong to a particular contact group?”
“Can I page through the member IDs of a contact group?”
Tell an agent
List the contact IDs in contact group {id}.
Show who is a member of contact group {id}.
PUT
/contact-groups/{id}/contacts/{contactId}
Add a contact to a contact group · Add Contact To Group
#
Ask an LLM
“How do I put a contact into one of my contact groups?”
“Can I add a single person to a group without re-saving the whole group?”
Tell an agent
Add contact {contactId} to contact group {id}.
Put contact {contactId} in group {id}.
DELETE
/contact-groups/{id}/contacts/{contactId}
Remove a contact from a contact group · Remove Contact From Group
#
Ask an LLM
“How do I take someone out of a contact group without deleting their contact record?”
“Can I remove just one member from a contact group?”
Tell an agent destructive · confirm first
Remove contact {contactId} from contact group {id}.
Take contact {contactId} out of group {id}.
Ask an LLM
“What contact types are defined in my account?”
“Can I filter the available contact types?”
Tell an agent
List all contact types.
List contact types matching {filter}.
Ask an LLM
“How do I pull all the contacts in my address book?”
“Can I include purged contacts when listing contacts?”
Tell an agent
List all my contacts.
List contacts updated after {after}.
Ask an LLM
“How do I update a batch of contacts in one request?”
“Do de-duplication fields like email need to stay unique when bulk-updating contacts?”
Tell an agent
Bulk update the contacts in this list with a full replacement of their values.
Overwrite these contacts' records in one batch update.
Ask an LLM
“How do I change just a couple of fields on many contacts while keeping everything else?”
“Can I bulk-patch contacts without wiping fields I don't send?”
Tell an agent
Patch only the supplied fields on this batch of contacts.
Apply a partial update to these contacts, leaving other values intact.
Ask an LLM
“How do I import a list of new contacts into my address book?”
“Can creating contacts update existing ones instead of failing on duplicates?”
Tell an agent
Create these new contacts in my address book.
Create these contacts with upsert set to {upsert}.
Ask an LLM
“My contact filter is too long for the URL — can I send it in the body?”
“Can I search contacts with a complex filter and a date range?”
Tell an agent
Search contacts using the body filter {filter}.
Find contacts matching body filter {filter} updated before {before}.
GET
/contacts/obfuscate/{obfuscateId}/status
Check a contact obfuscation's status · Get Obfuscation Status
#
Ask an LLM
“How do I know whether a contact's data has finished being obfuscated?”
“Can I check the progress of a GDPR-style contact obfuscation request?”
Tell an agent
Check the status of obfuscation request {obfuscateId}.
Tell me whether obfuscation {obfuscateId} has finished.
Ask an LLM
“Who changed a contact's record and when?”
“Can I see a contact's edit history within a date range?”
Tell an agent
Show the change history for contact {contactId}.
List changes to contact {contactId} made after {after}.
Ask an LLM
“How do I look up one contact's full record?”
“Are sensitive fields like passport number returned when I read a contact?”
Tell an agent
Get contact {id}.
Show the full record for contact {id}.
Ask an LLM
“How do I overwrite a contact's details with new values?”
“What scope do I need to write secure fields like date of birth on a contact?”
Tell an agent
Replace the record for contact {id} with these values.
Fully update contact {id} and set its parent contact to {parentId}.
Ask an LLM
“How do I change just a contact's company or title without touching other fields?”
“Can I clear a single field on a contact by setting it to null?”
Tell an agent
Change contact {id}'s company to {company}.
Set the job title of contact {id} to {title}.
Ask an LLM
“How do I delete a contact from my address book?”
“Does deleting a contact also remove them from events they're registered for?”
Tell an agent destructive · confirm first
Delete contact {id} from the address book.
Remove contact {id}, leaving their event registrations alone.
PUT
/contacts/{id}/custom-fields/{customFieldId}/answers
Set a contact's custom field answer · Update Custom Field Answers
#
Ask an LLM
“How do I fill in a custom question answer on a contact's profile?”
“Can I update one custom field value for a single contact?”
Tell an agent
Set custom field {customFieldId} on contact {id} to {value}.
Update contact {id}'s answer for custom field {customFieldId}.
Ask an LLM
“How do I merge duplicate contacts into one record?”
“How many contacts can be merged together at once?”
Tell an agent
Merge contacts {secondaryContacts} into contact {id}.
Merge duplicates {secondaryContacts} into {id}, resolving conflicts with {conflictResolution}.
Ask an LLM
“How do I permanently scrub a contact's personal data for a privacy request?”
“Is contact obfuscation reversible once it succeeds?”
Tell an agent destructive · confirm first
Obfuscate contact {id}.
Start irreversible obfuscation of all data for contact {id}.
DELETE
/contacts/{id}/profile-images
Remove a contact's profile picture · Delete Contact Profile Picture
#
Ask an LLM
“How do I remove the photo from a contact's profile?”
“Can I clear a contact's profile picture without deleting the contact?”
Tell an agent destructive · confirm first
Delete the profile picture of contact {id}.
Remove contact {id}'s profile photo.
PUT
/contacts/{id}/profile-images
Set a contact's profile picture · Assign Contact Profile Picture
#
Ask an LLM
“How do I add a profile photo to a contact?”
“Does assigning a new profile picture replace the contact's existing one?”
Tell an agent
Set uploaded file {file} as the profile picture for contact {id}.
Assign profile image {file} at {href} to contact {id}.
Ask an LLM
“Which contacts are linked to this contact, like a spouse or assistant?”
“Can I see all related contact IDs for one person?”
Tell an agent
List contacts related to contact {id}.
Show the related contact IDs for {id}.
PUT
/contacts/{id}/related-contacts/{relatedContactId}
Link two contacts as related · Add Contact Relationship
#
Ask an LLM
“How do I record that two contacts are related to each other?”
“Can I connect a contact to their guest or colleague in the address book?”
Tell an agent
Link contact {id} with related contact {relatedContactId}.
Add a relationship between contacts {id} and {relatedContactId}.
DELETE
/contacts/{id}/related-contacts/{relatedContactId}
Unlink two related contacts · Delete Contact Relationship
#
Ask an LLM
“How do I remove the relationship between two contacts?”
“Can I unlink related contacts without deleting either one?”
Tell an agent destructive · confirm first
Remove the relationship between contact {id} and {relatedContactId}.
Unlink related contact {relatedContactId} from contact {id}.