Skip to main content
Server path: /gist-contacts | Type: Application | PCID required: Yes

Tools

ToolDescription
gist_contacts_batch_create_contactsBatch create or update contacts
gist_contacts_create_or_update_contactCreate or update a contact
gist_contacts_create_or_update_tagCreate, update, or manage tag-contact associations
gist_contacts_delete_contactDelete a contact
gist_contacts_delete_tagDelete a tag
gist_contacts_get_batch_statusGet batch import status
gist_contacts_get_campaignRetrieve a campaign
gist_contacts_get_contactRetrieve a contact by ID
gist_contacts_get_segmentRetrieve a segment
gist_contacts_get_subscription_typeRetrieve a subscription type
gist_contacts_list_campaignsList all campaigns
gist_contacts_list_contactsList all contacts
gist_contacts_list_eventsList all events
gist_contacts_list_form_submissionsList form submissions
gist_contacts_list_formsList all forms
gist_contacts_list_segmentsList all segments
gist_contacts_list_subscription_typesList all subscription types
gist_contacts_list_tagsList all tags
gist_contacts_manage_campaign_subscriptionSubscribe or unsubscribe a contact from a campaign
gist_contacts_manage_subscription_type_contactAttach or detach a contact from a subscription type
gist_contacts_subscribe_contact_to_formSubscribe a contact to a form
gist_contacts_track_eventTrack a custom event

gist_contacts_batch_create_contacts

Batch create or update contacts Parameters:
ParameterTypeRequiredDefaultDescription
contactsobject[]YesArray of contact objects to create or update

gist_contacts_create_or_update_contact

Create or update a contact Parameters:
ParameterTypeRequiredDefaultDescription
custom_propertiesobjectNoCustom properties as key-value pairs
emailstringNoContact email address
last_seen_ipstringNoLast seen IP address
last_seen_user_agentstringNoLast seen user agent
namestringNoContact name
phonestringNoPhone number
signed_up_atintegerNoSign-up timestamp (Unix)
tagsstring[]NoTag names to add to the contact
unsubscribed_from_emailsbooleanNoWhether contact is unsubscribed from emails
user_idstringNoExternal user ID

gist_contacts_create_or_update_tag

Create, update, or manage tag-contact associations Parameters:
ParameterTypeRequiredDefaultDescription
contactsobject[]NoContacts to tag or untag
idstringNoTag ID (required for update or tag/untag operations)
namestringYesTag name

gist_contacts_delete_contact

Delete a contact Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesContact ID

gist_contacts_delete_tag

Delete a tag Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesTag ID

gist_contacts_get_batch_status

Get batch import status Parameters:
ParameterTypeRequiredDefaultDescription
batch_idstringYesBatch import ID

gist_contacts_get_campaign

Retrieve a campaign Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCampaign ID

gist_contacts_get_contact

Retrieve a contact by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesContact ID
user_idstringNoAlternative: look up by user_id
emailstringNoAlternative: look up by email

gist_contacts_get_segment

Retrieve a segment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesSegment ID
include_countbooleanNoInclude contact count

gist_contacts_get_subscription_type

Retrieve a subscription type Parameters:
ParameterTypeRequiredDefaultDescription
subscription_type_idintegerYesSubscription type ID

gist_contacts_list_campaigns

List all campaigns Parameters:
ParameterTypeRequiredDefaultDescription
statusstringNoFilter by status
pageintegerNoPage number
per_pageintegerNoResults per page

gist_contacts_list_contacts

List all contacts Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoResults per page (max 60)
orderstringNoSort order
order_bystringNoSort field
created_sinceintegerNoFilter contacts created in the last N days
statusstringNoFilter by status
form_idstringNoFilter by form ID
email_likestringNoFilter by email pattern
segment_idstringNoFilter by segment ID
campaign_idstringNoFilter by campaign ID
tag_idstringNoFilter by tag ID

gist_contacts_list_events

List all events Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoResults per page (max 60)

gist_contacts_list_form_submissions

List form submissions Parameters:
ParameterTypeRequiredDefaultDescription
form_idstringYesForm ID
pageintegerNoPage number
per_pageintegerNoResults per page (max 60)
orderstringNoSort order
order_bystringNoSort field

gist_contacts_list_forms

List all forms Parameters:
ParameterTypeRequiredDefaultDescription
form_idstringNoSpecific form ID to retrieve
pageintegerNoPage number
per_pageintegerNoResults per page (max 60)
orderstringNoSort order
order_bystringNoSort field
statusstringNoFilter by form status

gist_contacts_list_segments

List all segments Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoResults per page
orderstringNoSort order
order_bystringNoSort field
include_countbooleanNoInclude contact count per segment

gist_contacts_list_subscription_types

List all subscription types Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoResults per page

gist_contacts_list_tags

List all tags Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
per_pageintegerNoResults per page
orderstringNoSort order
order_bystringNoSort field

gist_contacts_manage_campaign_subscription

Subscribe or unsubscribe a contact from a campaign Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoContact email
idstringYesCampaign ID
reactivate_if_removedbooleanNoReactivate if previously removed
starting_email_indexintegerNoStarting email index (default 0)
unsubscribedbooleanNoSet to true to unsubscribe the contact
user_idstringNoContact user ID

gist_contacts_manage_subscription_type_contact

Attach or detach a contact from a subscription type Parameters:
ParameterTypeRequiredDefaultDescription
subscription_type_idintegerYesSubscription type ID
contact_idstringNoContact ID
emailstringNoContact email
subscribed_statusbooleanYesTrue to attach, false to detach
user_idstringNoContact user ID

gist_contacts_subscribe_contact_to_form

Subscribe a contact to a form Parameters:
ParameterTypeRequiredDefaultDescription
form_idstringYesForm ID
consent_to_processbooleanNoConsent to process data
consent_to_process_textstringNoConsent text
fieldsobjectYesForm field name/value pairs
ip_addressstringNoSubmitter’s IP address
page_titlestringNoPage title where form was submitted
page_urlstringNoPage URL where form was submitted
skip_validationbooleanNoSkip form field validation
submitted_atintegerNoSubmission timestamp (Unix ms)

gist_contacts_track_event

Track a custom event Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoContact email (required if no user_id or id)
event_namestringYesEvent name
idstringNoContact ID (required if no email or user_id)
occurred_atintegerNoUnix timestamp when the event occurred (defaults to now)
propertiesobjectNoEvent properties as key-value pairs
user_idstringNoUser ID (required if no email or id)