/gist-contacts | Type: Application | PCID required: Yes
Tools
gist_contacts_batch_create_contacts
Batch create or update contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contacts | object[] | Yes | — | Array of contact objects to create or update |
gist_contacts_create_or_update_contact
Create or update a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
custom_properties | object | No | — | Custom properties as key-value pairs |
email | string | No | — | Contact email address |
last_seen_ip | string | No | — | Last seen IP address |
last_seen_user_agent | string | No | — | Last seen user agent |
name | string | No | — | Contact name |
phone | string | No | — | Phone number |
signed_up_at | integer | No | — | Sign-up timestamp (Unix) |
tags | string[] | No | — | Tag names to add to the contact |
unsubscribed_from_emails | boolean | No | — | Whether contact is unsubscribed from emails |
user_id | string | No | — | External user ID |
gist_contacts_create_or_update_tag
Create, update, or manage tag-contact associations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contacts | object[] | No | — | Contacts to tag or untag |
id | string | No | — | Tag ID (required for update or tag/untag operations) |
name | string | Yes | — | Tag name |
gist_contacts_delete_contact
Delete a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Contact ID |
gist_contacts_delete_tag
Delete a tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Tag ID |
gist_contacts_get_batch_status
Get batch import status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
batch_id | string | Yes | — | Batch import ID |
gist_contacts_get_campaign
Retrieve a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Campaign ID |
gist_contacts_get_contact
Retrieve a contact by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Contact ID |
user_id | string | No | — | Alternative: look up by user_id |
email | string | No | — | Alternative: look up by email |
gist_contacts_get_segment
Retrieve a segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Segment ID |
include_count | boolean | No | — | Include contact count |
gist_contacts_get_subscription_type
Retrieve a subscription type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
subscription_type_id | integer | Yes | — | Subscription type ID |
gist_contacts_list_campaigns
List all campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | — | Filter by status |
page | integer | No | — | Page number |
per_page | integer | No | — | Results per page |
gist_contacts_list_contacts
List all contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
per_page | integer | No | — | Results per page (max 60) |
order | string | No | — | Sort order |
order_by | string | No | — | Sort field |
created_since | integer | No | — | Filter contacts created in the last N days |
status | string | No | — | Filter by status |
form_id | string | No | — | Filter by form ID |
email_like | string | No | — | Filter by email pattern |
segment_id | string | No | — | Filter by segment ID |
campaign_id | string | No | — | Filter by campaign ID |
tag_id | string | No | — | Filter by tag ID |
gist_contacts_list_events
List all events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
per_page | integer | No | — | Results per page (max 60) |
gist_contacts_list_form_submissions
List form submissions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
form_id | string | Yes | — | Form ID |
page | integer | No | — | Page number |
per_page | integer | No | — | Results per page (max 60) |
order | string | No | — | Sort order |
order_by | string | No | — | Sort field |
gist_contacts_list_forms
List all forms Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
form_id | string | No | — | Specific form ID to retrieve |
page | integer | No | — | Page number |
per_page | integer | No | — | Results per page (max 60) |
order | string | No | — | Sort order |
order_by | string | No | — | Sort field |
status | string | No | — | Filter by form status |
gist_contacts_list_segments
List all segments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
per_page | integer | No | — | Results per page |
order | string | No | — | Sort order |
order_by | string | No | — | Sort field |
include_count | boolean | No | — | Include contact count per segment |
gist_contacts_list_subscription_types
List all subscription types Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
per_page | integer | No | — | Results per page |
gist_contacts_list_tags
List all tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
per_page | integer | No | — | Results per page |
order | string | No | — | Sort order |
order_by | string | No | — | Sort field |
gist_contacts_manage_campaign_subscription
Subscribe or unsubscribe a contact from a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | Contact email |
id | string | Yes | — | Campaign ID |
reactivate_if_removed | boolean | No | — | Reactivate if previously removed |
starting_email_index | integer | No | — | Starting email index (default 0) |
unsubscribed | boolean | No | — | Set to true to unsubscribe the contact |
user_id | string | No | — | Contact user ID |
gist_contacts_manage_subscription_type_contact
Attach or detach a contact from a subscription type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
subscription_type_id | integer | Yes | — | Subscription type ID |
contact_id | string | No | — | Contact ID |
email | string | No | — | Contact email |
subscribed_status | boolean | Yes | — | True to attach, false to detach |
user_id | string | No | — | Contact user ID |
gist_contacts_subscribe_contact_to_form
Subscribe a contact to a form Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
form_id | string | Yes | — | Form ID |
consent_to_process | boolean | No | — | Consent to process data |
consent_to_process_text | string | No | — | Consent text |
fields | object | Yes | — | Form field name/value pairs |
ip_address | string | No | — | Submitter’s IP address |
page_title | string | No | — | Page title where form was submitted |
page_url | string | No | — | Page URL where form was submitted |
skip_validation | boolean | No | — | Skip form field validation |
submitted_at | integer | No | — | Submission timestamp (Unix ms) |
gist_contacts_track_event
Track a custom event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | Contact email (required if no user_id or id) |
event_name | string | Yes | — | Event name |
id | string | No | — | Contact ID (required if no email or user_id) |
occurred_at | integer | No | — | Unix timestamp when the event occurred (defaults to now) |
properties | object | No | — | Event properties as key-value pairs |
user_id | string | No | — | User ID (required if no email or id) |

