Create object/group
documentedCreate a non-person object (group) and relate it to people.
POST /v1/groupObjectsno implementation yet0 runsInput
user_id
User ID
e.g. user_123
group_id
Group ID
e.g. grp_001
object_type_id
Object Type ID
e.g. 1
role
Relationship role
e.g. primary_contact
group_name
Group name
e.g. Acme, Inc.
industry
Industry
e.g. Technology
plan
Plan
e.g. enterprise
total_billed
Total billed
e.g. 830
integrations_all
Integrations All
true or false
integrations_salesforce
Salesforce integration enabled
true or false
integrations_mixpanel
Mixpanel integration enabled
true or false
message_id
Message ID
unique Pipelines message id
sent_at
Sent at (ISO 8601)
YYYY-MM-DDTHH:MM:SSZ
original_timestamp
Original timestamp
ISO 8601
timestamp
Timestamp
ISO 8601
ip
IP address
e.g. 8.8.8.8
locale
Locale
e.g. en-US
user_agent
User agent
Browser User-Agent
campaign_name
Campaign name
e.g. Acme Campaign
campaign_source
Campaign source
e.g. newsletter
campaign_medium
Campaign medium
e.g. email
campaign_term
Campaign term
e.g. summer_sale
campaign_content
Campaign content
e.g. banner_ad
page_name
Page name
e.g. Homepage
page_path
Page path
e.g. /home
page_referrer
Page referrer
e.g. https://google.com
page_search
Page search
e.g. ?q=customer.io
page_title
Page title
e.g. Home
page_url
Page URL
e.g. https://example.com/home
page_keywords
Page keywords
e.g. customer.io, marketing
Calls Customer.io as you (your API key is your account); keychains.dev holds the credentials.