Simplero integration: operations for AI agents
Simplero connects to Type.com as an integration. This page lists the 1069 operations documented for Claude and Codex in Type.com: 304 read, 669 write, 96 destructive.
About Simplero
All-in-one marketing software for course creators, coaches and online marketers.
Categories: Marketing & Social
How to connect Simplero to Type.com
- Access
- Organization connection: one shared account for the workspace.
- MCP
- Selected payment-processing operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.
To add the connection, follow the steps in Space connections.
Documented operations
1069 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
1069 operations listed.
Access Grants
- Read
List access grants
GET /api/v2/access_grants
- Read
Get a access grant
GET /api/v2/access_grants/{id}
Account Currencies
- Read
List account currencies
GET /api/v2/account_currencies
- Read
Get a account currency
GET /api/v2/account_currencies/{id}
Actions
- Read
List available actions for a target type
Returns the action ids and titles available for a given target type. Target type is the model the action runs on (e.g. Customer, Ticket, Deal). Pass automation: true to filter to actions that can run inside automations/triggers.
- Read
Get the typed args schema for an action
Returns the typed args schema for a fully qualified action id, e.g. Customer-librarymailing. Use this to learn what to pass in the args field when creating or updating an Action.
- Read
List actions
GET /api/v2/actions
- Read
Get a action
GET /api/v2/actions/{id}
- Write
Create a action
POST /api/v2/actions
- Write
Update a action
PATCH /api/v2/actions/{id}
Administratorships
- Read
List administrators
GET /api/v2/administratorships
- Read
Get a administrator
GET /api/v2/administratorships/{id}
- Write
Resurrect
POST /api/v2/administratorships/{id}/actions/resurrect
Affiliate Clicks
- Read
List affiliate clicks
GET /api/v2/affiliate_clicks
- Read
Get a affiliate click
GET /api/v2/affiliate_clicks/{id}
Affiliate Links
- Read
List affiliate links
GET /api/v2/affiliate_links
- Read
Get a affiliate link
GET /api/v2/affiliate_links/{id}
- Write
Create a affiliate link
POST /api/v2/affiliate_links
- Write
Update a affiliate link
PATCH /api/v2/affiliate_links/{id}
Affiliate Programs
- Read
List affiliate programs
GET /api/v2/affiliate_programs
- Read
Get a affiliate program
GET /api/v2/affiliate_programs/{id}
- Write
Create a affiliate program
POST /api/v2/affiliate_programs
- Write
Update a affiliate program
PATCH /api/v2/affiliate_programs/{id}
- Write
Add labels
POST /api/v2/affiliate_programs/{id}/actions/add_labels
- Write
Reset registration link
POST /api/v2/affiliate_programs/{id}/actions/reset_registration_token
- Write
Star
POST /api/v2/affiliate_programs/{id}/actions/star
- Write
Unstar
POST /api/v2/affiliate_programs/{id}/actions/unstar
- Destructive
Remove label
POST /api/v2/affiliate_programs/{id}/actions/remove_label
Affiliates
- Read
List affiliates
GET /api/v2/affiliates
- Read
Get a affiliate
GET /api/v2/affiliates/{id}
- Write
Create a affiliate
POST /api/v2/affiliates
- Write
Update a affiliate
PATCH /api/v2/affiliates/{id}
- Write
Post message to conversation
POST /api/v2/affiliates/{id}/actions/post_to_conversation
- Write
Add to conversation
POST /api/v2/affiliates/{id}/actions/add_to_conversation
- Write
Approve
POST /api/v2/affiliates/{id}/actions/approve
- Write
Reject
POST /api/v2/affiliates/{id}/actions/reject
- Write
Retire
POST /api/v2/affiliates/{id}/actions/retire
- Write
Resend welcome
POST /api/v2/affiliates/{id}/actions/resend_welcome
- Write
Approve documentation
POST /api/v2/affiliates/{id}/actions/approve_documentation
- Write
Request documentation
POST /api/v2/affiliates/{id}/actions/request_documentation
- Write
Mark paid
POST /api/v2/affiliates/{id}/actions/mark_paid
- Write
Send login link
POST /api/v2/affiliates/{id}/actions/send_login_link
- Write
Move to other affiliate program
POST /api/v2/affiliates/{id}/actions/move_to_other_affiliate_program
Agentic Workflow Files
- Read
List agentic workflow files
GET /api/v2/agentic_workflow_files
- Read
Get a agentic workflow file
GET /api/v2/agentic_workflow_files/{id}
- Write
Create a agentic workflow file
POST /api/v2/agentic_workflow_files
- Write
Update a agentic workflow file
PATCH /api/v2/agentic_workflow_files/{id}
Agentic Workflow Runs
- Read
Read a run's activity log
Everything the agent has narrated, most recent last, as it now stands. This is a window onto the work rather than part of it: the log is bounded, so a long run's oldest turns are dropped.
- Read
List agentic workflow runs
GET /api/v2/agentic_workflow_runs
- Read
Get a agentic workflow run
GET /api/v2/agentic_workflow_runs/{id}
- Write
Send a message to a run
Everything a caller says to a run once it is under way. Send answer when the run is waiting on a question — waitingon on the run says what it asked. A run picks messages up on its own; there is nothing else to call afterwards.
- Write
Create a agentic workflow run
POST /api/v2/agentic_workflow_runs
- Write
Pause
POST /api/v2/agentic_workflow_runs/{id}/actions/pause
- Write
Resume
POST /api/v2/agentic_workflow_runs/{id}/actions/resume
- Write
Stop
POST /api/v2/agentic_workflow_runs/{id}/actions/stop
Agentic Workflows
- Read
List agentic workflows
GET /api/v2/agentic_workflows
- Read
Get a agentic workflow
GET /api/v2/agentic_workflows/{id}
- Write
Create a agentic workflow
POST /api/v2/agentic_workflows
- Write
Update a agentic workflow
PATCH /api/v2/agentic_workflows/{id}
Ai Credit Usage
- Read
Read AI credit usage by contact
Tracked credits for a site over [from, to), in UTC. Lists contacts with usage in the range; contactid also returns a contact with zero usage. Pending wallet debits are included. Top-level quota fields describe the site/account default, or bot quota when botid is supplied.
Alternative Prices
- Read
List alternative prices
GET /api/v2/alternative_prices
- Read
Get a alternative price
GET /api/v2/alternative_prices/{id}
- Write
Create a alternative price
POST /api/v2/alternative_prices
- Write
Update a alternative price
PATCH /api/v2/alternative_prices/{id}
Asset Bookmarks
- Read
List bookmarks
GET /api/v2/asset_bookmarks
- Read
Get a bookmark
GET /api/v2/asset_bookmarks/{id}
- Write
Create a bookmark
POST /api/v2/asset_bookmarks
- Write
Update a bookmark
PATCH /api/v2/asset_bookmarks/{id}
Assets
- Read
List media files
GET /api/v2/assets
- Read
Get a scaled image URL
Generates a URL for a scaled version of an image asset at the given dimensions. At least one of width or height must be provided. When both are given, constrain determines how the image is fit into the box.
- Read
Get a media file
GET /api/v2/assets/{id}
- Read
Show transcript in lesson
POST /api/v2/assets/{id}/actions/show_transcript
- Read
Show subtitles in video player
POST /api/v2/assets/{id}/actions/show_subtitles
- Write
Create a media file
Upload a file (image, video, document, etc.) via multipart form data.
- Write
Create an asset from a URL
Import a file (image, video, document, etc.) into the media library from an external HTTP(S) URL — no multipart upload needed.
- Write
Create an image crop
Creates or reuses an immutable crop recipe from oriented source pixels. The crop follows replacements of the original image. Output images are generated on demand; display width belongs to the placement.
- Write
Update a media file
PATCH /api/v2/assets/{id}
- Write
Resurrect
POST /api/v2/assets/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/assets/{id}/actions/add_labels
- Write
Restart encoding
POST /api/v2/assets/{id}/actions/restart_encoding
- Write
Force restart encoding (will restart if any service job is not locked)
POST /api/v2/assets/{id}/actions/force_restart_encoding
- Write
Normalize audio levels
POST /api/v2/assets/{id}/actions/apply_loudness_filter
- Write
Transcribe
POST /api/v2/assets/{id}/actions/deepgram
- Write
Extract text
POST /api/v2/assets/{id}/actions/extract_text
- Write
Regenerate bookmarks from transcript
POST /api/v2/assets/{id}/actions/recreate_bookmarks
- Write
Hide transcript in lesson
POST /api/v2/assets/{id}/actions/hide_transcript
- Write
Hide subtitles in video player
POST /api/v2/assets/{id}/actions/hide_subtitles
- Destructive
Remove label
POST /api/v2/assets/{id}/actions/remove_label
Attachments
- Read
Get a attachment
GET /api/v2/attachments/{id}
- Read
List attachments
GET /api/v2/attachments
- Write
Update a attachment
PATCH /api/v2/attachments/{id}
- Write
Create a attachment
POST /api/v2/attachments
- Destructive
Delete an attachment
Removes the attachment from whatever it hangs off (lesson, product, page, …). The asset or worksheet it points at is left alone.
Automations
- Read
List automations
GET /api/v2/automations
- Read
Get a automation
GET /api/v2/automations/{id}
- Write
Create a automation
POST /api/v2/automations
- Write
Update a automation
PATCH /api/v2/automations/{id}
- Write
Resurrect
POST /api/v2/automations/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/automations/{id}/actions/add_labels
- Write
Star
POST /api/v2/automations/{id}/actions/star
- Write
Unstar
POST /api/v2/automations/{id}/actions/unstar
- Write
Duplicate
POST /api/v2/automations/{id}/actions/duplicate
- Write
Duplicate & reuse same emails
POST /api/v2/automations/{id}/actions/duplicate_reuse
- Destructive
Remove label
POST /api/v2/automations/{id}/actions/remove_label
Availabilities
- Read
List availability presets
GET /api/v2/availabilities
- Read
Get a availability preset
GET /api/v2/availabilities/{id}
- Write
Create a availability preset
POST /api/v2/availabilities
- Write
Update a availability preset
PATCH /api/v2/availabilities/{id}
- Write
Resurrect
POST /api/v2/availabilities/{id}/actions/resurrect
Availability Periods
- Read
List availability periods
GET /api/v2/availability_periods
- Read
Get a availability period
GET /api/v2/availability_periods/{id}
- Write
Create a availability period
POST /api/v2/availability_periods
- Write
Update a availability period
PATCH /api/v2/availability_periods/{id}
Awarded Certificates
- Read
List awarded certificates
GET /api/v2/awarded_certificates
- Read
Get a awarded certificate
GET /api/v2/awarded_certificates/{id}
Blocks
- Read
List saved blocks
GET /api/v2/blocks
- Read
Get a saved block
GET /api/v2/blocks/{id}
- Read
List available builder node types
Returns node types that can be added to this builder doc. If parentnodeid is given, filters to types valid as children of that node.
- Read
Get builder node type schema
Returns the list of settings available on a single node type. Type is passed as a query param because it may contain slashes. To get the full args schema (defaults, types) for a specific setting, call the nodetypes/settingsdetail endpoint with the setting ids you care about.
- Read
Get builder node type settings detail
Returns the full args schema (defaults, types) for one or more settings of a given node type. Scoped by the node type. Returns a hash keyed by setting id.
- Read
Get the builder doc node tree
Returns the full working-version node tree for this record.
- Read
Get a builder doc node
Returns a single node by id from the working version.
- Read
Get HTML section content
Returns the HTML content of the htmlsection node with the given id.
- Read
List builder doc version history
Returns the active working lineage of this record's builder doc, newest first, plus publish/working status. Compacted and orphaned versions are omitted.
- Read
Get a builder doc version
Returns one version, including its node tree. The version must belong to this record's builder doc; compacted/orphaned versions are still fetchable by id.
- Read
Run WCAG 2.1 AA accessibility check
Audits the working version of this record's builder doc (and its style guide) for WCAG 2.1 AA issues: color contrast (text vs background on palette roles and color styles), missing image alt text, heading hierarchy, and keyboard/focus risks in HTML sections.
- Read
List where this block is embedded
Returns pages, landing pages, and other builder owners in this account that embed this block (via blockid on a node). Scans both the published version and the working draft of each builder doc, so a draft that removes a still-live embed cannot hide it.
- Write
Create a block
Create a Saved or Global block from a builder node tree. Required: name and content (a single root node hash: section, row, column, or element — same shape as builder nodes create). basetype is derived from the root node.
- Write
Update a saved block
PATCH /api/v2/blocks/{id}
- Write
Create a builder doc node
Adds a new node to the tree under the given parent. Pass publishchanges: true to publish the working version immediately.
- Write
Update a builder doc node
Partial update — only the keys you pass are merged into the node. Settings are deep-merged. Pass publishchanges: true to publish the working version immediately.
- Write
Unlink a global block instance
Detaches a live-linked global block instance into a normal local section (copies current block content into the page). Mirrors the builder Unlink control. Only valid for global block instances.
- Write
Generate embed markup for a node type
Returns a custom element markup string that you can paste into the html of an htmlsection to embed a structured builder node (e.g. an order form, input field, button, signup form, etc.) inside free-form HTML. How to use: 1.
- Write
Create or update HTML section content
Create or update the HTML content of an htmlsection node. nodeid is required. Pass either: The id of an existing htmlsection node — updates its HTML. The literal string "createnew" — creates a new htmlsection node under the root with the given html.
- Write
Publish the working version
Publishes the current working version of this record's builder doc, making staged changes live. Fails when the working draft is disconnected from the published version — POST builder/content/discardunpublishedchanges first.
- Write
Restore a builder doc version
Creates a new working draft whose content matches the given version. Does not publish. The restored snapshot is always a new version on top of the current working version (same as Restore this version in the editor).
- Write
Discard unpublished builder doc changes
Throws away the working draft and reconnects working to the currently published version. This is the operation that repairs a disconnected working lineage so publish can succeed. No-op-success when working is already the published version.
- Write
Add labels
POST /api/v2/blocks/{id}/actions/add_labels
- Write
Add facet values
POST /api/v2/blocks/{id}/actions/add_facet_values
- Destructive
Delete a builder doc node
Removes a node from the tree. Pass publishchanges: true to publish the working version immediately.
- Destructive
Remove label
POST /api/v2/blocks/{id}/actions/remove_label
- Destructive
Remove facet values
POST /api/v2/blocks/{id}/actions/remove_facet_values
Blog Posts
- Read
List blog posts
GET /api/v2/blog_posts
- Read
Get a blog post
GET /api/v2/blog_posts/{id}
- Write
Update a blog post
PATCH /api/v2/blog_posts/{id}
- Write
Resurrect
POST /api/v2/blog_posts/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/blog_posts/{id}/actions/add_labels
- Write
Add facet values
POST /api/v2/blog_posts/{id}/actions/add_facet_values
- Write
Duplicate
POST /api/v2/blog_posts/{id}/actions/duplicate
- Write
Move to other site
POST /api/v2/blog_posts/{id}/actions/move_to_other_site
- Write
Duplicate to other site
POST /api/v2/blog_posts/{id}/actions/duplicate_to_other_site
- Write
Publish
POST /api/v2/blog_posts/{id}/actions/publish
- Write
Unpublish
POST /api/v2/blog_posts/{id}/actions/unpublish
- Write
Pin
POST /api/v2/blog_posts/{id}/actions/pin
- Write
Unpin
POST /api/v2/blog_posts/{id}/actions/unpin
- Write
Change categories
POST /api/v2/blog_posts/{id}/actions/categorize
- Destructive
Remove label
POST /api/v2/blog_posts/{id}/actions/remove_label
- Destructive
Remove facet values
POST /api/v2/blog_posts/{id}/actions/remove_facet_values
Bot Channels
- Read
List channels
GET /api/v2/bot_channels
- Read
Get a channel
GET /api/v2/bot_channels/{id}
- Write
Create a channel
POST /api/v2/bot_channels
- Write
Update a channel
PATCH /api/v2/bot_channels/{id}
- Destructive
Delete Channel
POST /api/v2/bot_channels/{id}/actions/delete
Bot Sources
- Read
List sources
GET /api/v2/bot_sources
- Read
Get a source
GET /api/v2/bot_sources/{id}
- Write
Create a source
POST /api/v2/bot_sources
- Write
Update a source
PATCH /api/v2/bot_sources/{id}
- Destructive
Delete Source
POST /api/v2/bot_sources/{id}/actions/delete
Bot Tiers
- Read
List bot tiers
GET /api/v2/bot_tiers
- Read
Get a bot tier
GET /api/v2/bot_tiers/{id}
- Write
Create a bot tier
POST /api/v2/bot_tiers
- Write
Update a bot tier
PATCH /api/v2/bot_tiers/{id}
Bots
- Read
List bots
GET /api/v2/bots
- Read
Get a bot
GET /api/v2/bots/{id}
- Write
Create a bot
POST /api/v2/bots
- Write
Update a bot
PATCH /api/v2/bots/{id}
- Write
Add bot to site(s)
POST /api/v2/bots/{id}/actions/add_to_site
- Write
Duplicate
POST /api/v2/bots/{id}/actions/duplicate
- Write
Add labels
POST /api/v2/bots/{id}/actions/add_labels
- Destructive
Remove bot from site(s)
POST /api/v2/bots/{id}/actions/remove_from_site
- Destructive
Remove label
POST /api/v2/bots/{id}/actions/remove_label
Broadcast Schedules
- Read
List newsletters
GET /api/v2/broadcast_schedules
- Read
Get a newsletter
GET /api/v2/broadcast_schedules/{id}
Broadcasts
- Read
List email broadcasts
GET /api/v2/broadcasts
- Read
Get a email broadcast
GET /api/v2/broadcasts/{id}
Builder Docs
- Read
Look up a builder doc by id
Returns the builder doc's owner and role, plus the API paths to use for it. builderapipath is the prefix of the owner's builder endpoints for this doc — append e.g. /nodes or /htmlsection (see the owner resource's endpoints). It is null when the owner has no builder API (e.g.
Charges
- Read
List charges
GET /api/v2/charges
- Read
Get a charge
GET /api/v2/charges/{id}
Chat Bot Conversations
- Read
List conversations
GET /api/v2/chat_bot_conversations
- Read
Get a conversation
GET /api/v2/chat_bot_conversations/{id}
Chat Bot Messages
- Read
List messages
GET /api/v2/chat_bot_messages
- Read
Get a message
GET /api/v2/chat_bot_messages/{id}
Chat Bot Opening Messages
- Read
List opening messages
GET /api/v2/chat_bot_opening_messages
- Read
Get a opening message
GET /api/v2/chat_bot_opening_messages/{id}
- Write
Create a opening message
POST /api/v2/chat_bot_opening_messages
- Write
Update a opening message
PATCH /api/v2/chat_bot_opening_messages/{id}
- Destructive
Delete Opening message
POST /api/v2/chat_bot_opening_messages/{id}/actions/delete
Countdown Instances
- Read
List countdown instances
GET /api/v2/countdown_instances
- Read
Get a countdown instance
GET /api/v2/countdown_instances/{id}
Countdown Timers
- Read
List countdown timers
GET /api/v2/countdown_timers
- Read
Get a countdown timer
GET /api/v2/countdown_timers/{id}
- Write
Create a countdown timer
POST /api/v2/countdown_timers
- Write
Update a countdown timer
PATCH /api/v2/countdown_timers/{id}
- Write
Resurrect
POST /api/v2/countdown_timers/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/countdown_timers/{id}/actions/add_labels
- Destructive
Remove label
POST /api/v2/countdown_timers/{id}/actions/remove_label
Coupons
- Read
List coupons
GET /api/v2/coupons
- Read
Get a coupon
GET /api/v2/coupons/{id}
- Write
Create a coupon
POST /api/v2/coupons
- Write
Update a coupon
PATCH /api/v2/coupons/{id}
- Write
Resurrect
POST /api/v2/coupons/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/coupons/{id}/actions/add_labels
- Write
Duplicate
POST /api/v2/coupons/{id}/actions/duplicate
- Destructive
Remove label
POST /api/v2/coupons/{id}/actions/remove_label
Course Lesson Completions
- Read
List course lesson completions
GET /api/v2/course_lesson_completions
- Read
Get a course lesson completion
GET /api/v2/course_lesson_completions/{id}
Course Lessons
- Read
List lessons
GET /api/v2/course_lessons
- Read
Get a lesson
GET /api/v2/course_lessons/{id}
- Write
Create a lesson
POST /api/v2/course_lessons
- Write
Update a lesson
PATCH /api/v2/course_lessons/{id}
- Write
Resurrect
POST /api/v2/course_lessons/{id}/actions/resurrect
- Write
Give access
POST /api/v2/course_lessons/{id}/actions/grant_access
- Write
Set author
POST /api/v2/course_lessons/{id}/actions/set_author
- Write
Change no access to COURSE behavior
POST /api/v2/course_lessons/{id}/actions/update_show_unauthorized_course
- Write
Change no access to LESSON behavior
POST /api/v2/course_lessons/{id}/actions/update_show_unauthorized_lesson
- Write
Change alternative content when no access to lesson
POST /api/v2/course_lessons/{id}/actions/update_unauthorized_message
- Write
Start at user preferred speed
POST /api/v2/course_lessons/{id}/actions/enable_preferred_playback_rate
- Write
Start at 1x speed
POST /api/v2/course_lessons/{id}/actions/disable_preferred_playback_rate
- Write
Allow multiple completions
POST /api/v2/course_lessons/{id}/actions/allow_multiple_completions
- Write
Disallow multiple completions
POST /api/v2/course_lessons/{id}/actions/disallow_multiple_completions
- Write
Duplicate
POST /api/v2/course_lessons/{id}/actions/duplicate
- Write
Publish
POST /api/v2/course_lessons/{id}/actions/publish
- Write
Unpublish
POST /api/v2/course_lessons/{id}/actions/unpublish
- Write
Move to module
POST /api/v2/course_lessons/{id}/actions/move_module
- Write
Transcribe video/audio lessons
POST /api/v2/course_lessons/{id}/actions/deepgram
- Write
Regenerate bookmarks from transcript
POST /api/v2/course_lessons/{id}/actions/recreate_bookmarks
- Write
Regenerate AI description
POST /api/v2/course_lessons/{id}/actions/regenerate_ai_description
- Write
Apply loudness filter
POST /api/v2/course_lessons/{id}/actions/apply_loudness_filter
- Write
Always start media from the beginning
POST /api/v2/course_lessons/{id}/actions/start_from_beginning
- Write
Resume media from the last position
POST /api/v2/course_lessons/{id}/actions/resume_from_last_position
- Write
Update lesson asset loop
POST /api/v2/course_lessons/{id}/actions/update_loop_asset
- Destructive
Delete AI generated summary
POST /api/v2/course_lessons/{id}/actions/delete_ai_generated_summary
Course Modules
- Read
List modules
GET /api/v2/course_modules
- Read
Get a module
GET /api/v2/course_modules/{id}
- Write
Create a module
POST /api/v2/course_modules
- Write
Update a module
PATCH /api/v2/course_modules/{id}
- Write
Resurrect
POST /api/v2/course_modules/{id}/actions/resurrect
- Write
Give access
POST /api/v2/course_modules/{id}/actions/grant_access
- Write
Publish
POST /api/v2/course_modules/{id}/actions/publish
- Write
Unpublish
POST /api/v2/course_modules/{id}/actions/unpublish
- Write
Restart module for all members
POST /api/v2/course_modules/{id}/actions/restart_all_members
- Write
Duplicate
POST /api/v2/course_modules/{id}/actions/duplicate
- Write
Add lessons from media files
POST /api/v2/course_modules/{id}/actions/add_lessons_from_assets
- Write
Duplicate to other course
POST /api/v2/course_modules/{id}/actions/copy_to_course
- Write
Move to other course
POST /api/v2/course_modules/{id}/actions/move_to_course
- Write
Reorder lessons by title
POST /api/v2/course_modules/{id}/actions/reorder_lessons_by_title
- Destructive
Remove common lesson title prefix
POST /api/v2/course_modules/{id}/actions/remove_common_lesson_title_prefix
Courses
- Read
List courses
GET /api/v2/courses
- Read
Get a course
GET /api/v2/courses/{id}
- Read
Show content duration
POST /api/v2/courses/{id}/actions/show_content_duration
- Read
Show content counts
POST /api/v2/courses/{id}/actions/show_content_counts
- Read
Show on the Site Course directory page
POST /api/v2/courses/{id}/actions/show_on_index
- Read
Show a teaser to people without access
POST /api/v2/courses/{id}/actions/on_site_tease
- Write
Create a course
POST /api/v2/courses
- Write
Update a course
PATCH /api/v2/courses/{id}
- Write
Resurrect
POST /api/v2/courses/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/courses/{id}/actions/add_labels
- Write
Add facet values
POST /api/v2/courses/{id}/actions/add_facet_values
- Write
Publish
POST /api/v2/courses/{id}/actions/publish
- Write
Drip
POST /api/v2/courses/{id}/actions/drip
- Write
Unpublish
POST /api/v2/courses/{id}/actions/unpublish
- Write
Move to other site
POST /api/v2/courses/{id}/actions/move_to_other_site
- Write
Duplicate
POST /api/v2/courses/{id}/actions/duplicate
- Write
Duplicate to other site
POST /api/v2/courses/{id}/actions/duplicate_to_other_site
- Write
Give access
POST /api/v2/courses/{id}/actions/grant_access
- Write
Prevent downloads
POST /api/v2/courses/{id}/actions/prevent_downloads
- Write
Allow downloads
POST /api/v2/courses/{id}/actions/allow_downloads
- Write
Enable autoplay
POST /api/v2/courses/{id}/actions/enable_autoplay
- Write
Disable autoplay
POST /api/v2/courses/{id}/actions/disable_autoplay
- Write
Refresh card image
POST /api/v2/courses/{id}/actions/refresh_card_image
- Write
Hide content duration
POST /api/v2/courses/{id}/actions/hide_content_duration
- Write
Hide content counts
POST /api/v2/courses/{id}/actions/hide_content_counts
- Write
Hide from the Site Course directory page
POST /api/v2/courses/{id}/actions/hide_from_index
- Write
Exclude from "New content" blocks
POST /api/v2/courses/{id}/actions/exclude_from_new_content
- Write
Include in "New content" blocks
POST /api/v2/courses/{id}/actions/include_in_new_content
- Write
Hide from people without access
POST /api/v2/courses/{id}/actions/on_site_hide
- Write
Transcribe video/audio lessons
POST /api/v2/courses/{id}/actions/deepgram
- Write
Restart course progress for all members
POST /api/v2/courses/{id}/actions/restart_all_members
- Destructive
Remove label
POST /api/v2/courses/{id}/actions/remove_label
- Destructive
Remove facet values
POST /api/v2/courses/{id}/actions/remove_facet_values
- Destructive
Delete AI generated summaries for all lessons
POST /api/v2/courses/{id}/actions/delete_ai_generated_summaries
Credit Balances
- Read
Read account credit balances
Account-owned wallets only. Contact and personal Simplero-ID wallets are not included.
- Read
Read an account credit balance
GET /api/v2/credit_balances/{id}
- Read
Read the ledger for an account credit balance
Signed ledger changes with stored product/note metadata and token totals from linked AI usage. Token fields are null when no linked usage is available. Date filters use UTC [from, to).
Credits
- Read
List credits
GET /api/v2/credits
- Read
Get a credit
GET /api/v2/credits/{id}
- Write
Create a credit
POST /api/v2/credits
- Write
Update a credit
PATCH /api/v2/credits/{id}
- Write
Resurrect
POST /api/v2/credits/{id}/actions/resurrect
- Write
Star
POST /api/v2/credits/{id}/actions/star
- Write
Unstar
POST /api/v2/credits/{id}/actions/unstar
- Write
Add labels
POST /api/v2/credits/{id}/actions/add_labels
- Destructive
Remove label
POST /api/v2/credits/{id}/actions/remove_label
Custom Domains
- Read
List custom domains
GET /api/v2/custom_domains
- Read
Get a custom domain
GET /api/v2/custom_domains/{id}
- Write
Create a custom domain
POST /api/v2/custom_domains
- Write
Update a custom domain
PATCH /api/v2/custom_domains/{id}
- Write
Resurrect
POST /api/v2/custom_domains/{id}/actions/resurrect
- Write
Recheck DNS
POST /api/v2/custom_domains/{id}/actions/recheck
- Write
Snapshot DNS
POST /api/v2/custom_domains/{id}/actions/snapshot_dns
Customer Notes
- Read
List notes
GET /api/v2/customer_notes
- Read
Get a note
GET /api/v2/customer_notes/{id}
- Write
Create a note
POST /api/v2/customer_notes
- Write
Update a note
PATCH /api/v2/customer_notes/{id}
- Write
Resurrect
POST /api/v2/customer_notes/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/customer_notes/{id}/actions/add_labels
- Destructive
Remove label
POST /api/v2/customer_notes/{id}/actions/remove_label
Customers
- Read
Read a contact's credit balances
The credit balances this contact holds, one entry per credit type. This is the same data as the credits field on the contact.
- Read
List contacts
GET /api/v2/customers
- Read
Get a contact
GET /api/v2/customers/{id}
- Write
Create a contact
POST /api/v2/customers
- Write
Update a contact
PATCH /api/v2/customers/{id}
- Write
Resurrect
POST /api/v2/customers/{id}/actions/resurrect
- Write
Fix repeating name (e.g. "John Smith Smith")
POST /api/v2/customers/{id}/actions/clean_name
- Write
Send password reset
POST /api/v2/customers/{id}/actions/send_password_reset
- Write
Send Simplero ID
POST /api/v2/customers/{id}/actions/send_simplero_id
- Write
Set Affiliate for Contact
POST /api/v2/customers/{id}/actions/set_affiliate
- Write
Set Contact as their own Affiliate
POST /api/v2/customers/{id}/actions/set_own_affiliate
- Write
Send chat message
POST /api/v2/customers/{id}/actions/send_chat_message
- Write
Add to affiliate program
POST /api/v2/customers/{id}/actions/add_to_affiliate_program
- Write
Give GDPR consent
POST /api/v2/customers/{id}/actions/give_consent
- Write
Display notice
POST /api/v2/customers/{id}/actions/notice
- Write
Assign a task
POST /api/v2/customers/{id}/actions/task
- Write
Send notification email
POST /api/v2/customers/{id}/actions/email
- Write
Send notification text message
POST /api/v2/customers/{id}/actions/text_message
- Write
Subscribe to a list in Mailchimp
POST /api/v2/customers/{id}/actions/mailchimp_subscribe
- Write
Unsubscribe from a list in Mailchimp
POST /api/v2/customers/{id}/actions/mailchimp_unsubscribe
- Write
Add engagement badge
POST /api/v2/customers/{id}/actions/add_badge
- Write
Set date field to relative time
POST /api/v2/customers/{id}/actions/set_date_to_now
- Write
Set text field
POST /api/v2/customers/{id}/actions/set_text_field
- Write
Start automation
POST /api/v2/customers/{id}/actions/start_automation
- Write
Stop automation
POST /api/v2/customers/{id}/actions/stop_automation
- Write
Pause automation
POST /api/v2/customers/{id}/actions/pause_automation
- Write
Resume automation
POST /api/v2/customers/{id}/actions/resume_automation
- Write
Continue automation now
POST /api/v2/customers/{id}/actions/continue_automation
- Write
Stop all automations for Contact
POST /api/v2/customers/{id}/actions/stop_all_automations
- Write
Pause all automations for Contact
POST /api/v2/customers/{id}/actions/pause_all_automations
- Write
Start countdown timer
POST /api/v2/customers/{id}/actions/start_countdown_timer
- Write
Extend countdown timer
POST /api/v2/customers/{id}/actions/extend_countdown_timer
- Write
Mark as Do Not Contact
POST /api/v2/customers/{id}/actions/mark_as_do_not_contact
- Write
Unmark as Do Not Contact
POST /api/v2/customers/{id}/actions/unmark_as_do_not_contact
- Write
Suppress (mark email as bounced)
POST /api/v2/customers/{id}/actions/mark_as_email_bounced
- Write
Unsuppress (unmark email as bounced)
POST /api/v2/customers/{id}/actions/unmark_as_email_bounced
- Write
Re-verify email
POST /api/v2/customers/{id}/actions/reverify_email
- Write
Unarchive Contact
POST /api/v2/customers/{id}/actions/mark_as_unarchived
- Write
Mark Contact engaged
POST /api/v2/customers/{id}/actions/mark_as_warm
- Write
Mark Contact unengaged
POST /api/v2/customers/{id}/actions/mark_as_cold
- Write
Unsubscribe from everything
POST /api/v2/customers/{id}/actions/unsubscribe_everything
- Write
Register for an event
POST /api/v2/customers/{id}/actions/register_for_an_event
- Write
Register for next upcoming occurrence of event
POST /api/v2/customers/{id}/actions/register_for_next_occurrence
- Write
Approve registration for an event
POST /api/v2/customers/{id}/actions/approve_registration_for_an_event
- Write
Deny registration for an event (if pending)
POST /api/v2/customers/{id}/actions/deny_registration_for_an_event
- Write
Issue credits
POST /api/v2/customers/{id}/actions/credit_issue
- Write
Consume credits
POST /api/v2/customers/{id}/actions/credit_consume
- Write
Create deal in pipeline
POST /api/v2/customers/{id}/actions/create_deal
- Write
Move deal to pipeline stage
POST /api/v2/customers/{id}/actions/move_deal
- Write
Give access to space
POST /api/v2/customers/{id}/actions/space_grant
- Write
Give access to page
POST /api/v2/customers/{id}/actions/category_grant
- Write
Post to webhook
POST /api/v2/customers/{id}/actions/webhook
- Write
Send text message
POST /api/v2/customers/{id}/actions/customer_sms
- Write
Purchase product without paying
POST /api/v2/customers/{id}/actions/product_purchase
- Write
Pause existing purchase of product
POST /api/v2/customers/{id}/actions/product_pause
- Write
Resume existing purchase of product
POST /api/v2/customers/{id}/actions/product_resume
- Write
Turn off auto-renew for existing purchase of product
POST /api/v2/customers/{id}/actions/product_auto_renew_off
- Write
Turn on auto-renew for existing purchase of product
POST /api/v2/customers/{id}/actions/product_auto_renew_on
- Write
Create paid purchase
POST /api/v2/customers/{id}/actions/bulk_purchase
- Write
Add paid purchase to a product
POST /api/v2/customers/{id}/actions/product_add_paid_purchase
- Write
Reset auto-responses for a product participant
POST /api/v2/customers/{id}/actions/product_reset_auto_responses
- Write
Add a tag
POST /api/v2/customers/{id}/actions/add_tag
- Write
Adjust lead score
POST /api/v2/customers/{id}/actions/adjust_lead_score
- Write
Subscribe to list
POST /api/v2/customers/{id}/actions/list_subscribe
- Write
Unsubscribe from list
POST /api/v2/customers/{id}/actions/list_unsubscribe
- Write
Resubscribe to list
POST /api/v2/customers/{id}/actions/list_resubscribe
- Write
Unsubscribe from all lists
POST /api/v2/customers/{id}/actions/list_unsubscribe_all
- Write
Suspend subscription to list
POST /api/v2/customers/{id}/actions/subscription_suspend
- Write
Resume subscription to list
POST /api/v2/customers/{id}/actions/subscription_resume
- Write
Reset auto-responses for a list subscriber
POST /api/v2/customers/{id}/actions/list_reset_auto_responses
- Write
Give access to site
POST /api/v2/customers/{id}/actions/site_grant
- Write
Unsubscribe from all notifications on site
POST /api/v2/customers/{id}/actions/site_notifications_unsubscribe
- Write
Upvote idea
POST /api/v2/customers/{id}/actions/idea_upvote
- Write
Give access to a page
POST /api/v2/customers/{id}/actions/page_grant
- Write
Give access to group
POST /api/v2/customers/{id}/actions/site_group_grant
- Write
Give access to a course
POST /api/v2/customers/{id}/actions/course_grant
- Write
Issue a course certificate
POST /api/v2/customers/{id}/actions/course_certificate_issue
- Write
Give access to a course module
POST /api/v2/customers/{id}/actions/course_module_grant
- Write
Give access to a course lesson
POST /api/v2/customers/{id}/actions/course_lesson_grant
- Write
Send SPEAR email
POST /api/v2/customers/{id}/actions/spear_email
- Write
Send email
POST /api/v2/customers/{id}/actions/single_action_library_mailing
- Write
Send existing email from Library
POST /api/v2/customers/{id}/actions/library_mailing
- Write
Request contract signature
POST /api/v2/customers/{id}/actions/request_signature
- Write
Add to coaching program
POST /api/v2/customers/{id}/actions/coaching_client_add
- Write
Add to Simplero Chat conversation
POST /api/v2/customers/{id}/actions/add_to_conversation
- Write
Give access to podcast
POST /api/v2/customers/{id}/actions/podcast_grant
- Write
Give access to bot tier
POST /api/v2/customers/{id}/actions/bot_tier_grant
- Write
Add to Meta custom audience
POST /api/v2/customers/{id}/actions/add_to_meta_custom_audience
- Destructive
Remove Simplero ID
POST /api/v2/customers/{id}/actions/remove_simplero_id
- Destructive
Remove Affiliate for Contact
POST /api/v2/customers/{id}/actions/remove_affiliate
- Destructive
Revoke GDPR consent
POST /api/v2/customers/{id}/actions/revoke_consent
- Destructive
Remove engagement badge
POST /api/v2/customers/{id}/actions/remove_badge
- Destructive
Cancel countdown timer
POST /api/v2/customers/{id}/actions/cancel_countdown_timer
- Destructive
Archive Contact
POST /api/v2/customers/{id}/actions/mark_as_archived
- Destructive
Cancel registration for next upcoming occurrence of event
POST /api/v2/customers/{id}/actions/deregister_for_next_occurrence
- Destructive
Cancel registration for all upcoming occurrences of event
POST /api/v2/customers/{id}/actions/deregister_for_all_occurrences
- Destructive
Cancel registration for an event (if approved)
POST /api/v2/customers/{id}/actions/cancel_registration_for_an_event
- Destructive
Revoke access to space
POST /api/v2/customers/{id}/actions/space_revoke
- Destructive
Revoke access to page
POST /api/v2/customers/{id}/actions/category_revoke
- Destructive
Cancel existing purchase of product
POST /api/v2/customers/{id}/actions/product_cancel
- Destructive
Cancel all purchases
POST /api/v2/customers/{id}/actions/cancel_all_purchases
- Destructive
Remove a tag
POST /api/v2/customers/{id}/actions/remove_tag
- Destructive
Remove all tags
POST /api/v2/customers/{id}/actions/remove_all_tags
- Destructive
Revoke access to site
POST /api/v2/customers/{id}/actions/site_revoke
- Destructive
Revoke access to a page
POST /api/v2/customers/{id}/actions/page_revoke
- Destructive
Revoke access to group
POST /api/v2/customers/{id}/actions/site_group_revoke
- Destructive
Revoke access to a course
POST /api/v2/customers/{id}/actions/course_revoke
- Destructive
Revoke access to a course module
POST /api/v2/customers/{id}/actions/course_module_revoke
- Destructive
Revoke access to a course lesson
POST /api/v2/customers/{id}/actions/course_lesson_revoke
- Destructive
Remove from Simplero Chat conversation
POST /api/v2/customers/{id}/actions/remove_from_conversation
- Destructive
Revoke access to podcast
POST /api/v2/customers/{id}/actions/podcast_revoke
- Destructive
Revoke access to bot tier
POST /api/v2/customers/{id}/actions/bot_tier_revoke
- Destructive
Remove from Meta custom audience
POST /api/v2/customers/{id}/actions/remove_from_meta_custom_audience
Deals
- Read
List deals
GET /api/v2/deals
- Read
Get a deal
GET /api/v2/deals/{id}
- Write
Create a deal
POST /api/v2/deals
- Write
Update a deal
PATCH /api/v2/deals/{id}
- Write
Move to pipeline stage
POST /api/v2/deals/{id}/actions/move_to_stage
- Write
Move to pipeline
POST /api/v2/deals/{id}/actions/move_to_pipeline
- Write
Set product
POST /api/v2/deals/{id}/actions/set_product_id
- Write
Set value
POST /api/v2/deals/{id}/actions/set_value
Delivery Replies
- Read
List replies
GET /api/v2/delivery_replies
- Read
Get a reply
GET /api/v2/delivery_replies/{id}
Docs
- Read
List docs
GET /api/v2/docs
- Read
Get a doc
GET /api/v2/docs/{id}
- Read
List available builder node types
Returns node types that can be added to this builder doc. If parentnodeid is given, filters to types valid as children of that node.
- Read
Get builder node type schema
Returns the list of settings available on a single node type. Type is passed as a query param because it may contain slashes. To get the full args schema (defaults, types) for a specific setting, call the nodetypes/settingsdetail endpoint with the setting ids you care about.
- Read
Get builder node type settings detail
Returns the full args schema (defaults, types) for one or more settings of a given node type. Scoped by the node type. Returns a hash keyed by setting id.
- Read
Get the builder doc node tree
Returns the full working-version node tree for this record.
- Read
Get a builder doc node
Returns a single node by id from the working version.
- Read
Get HTML section content
Returns the HTML content of the htmlsection node with the given id.
- Read
List builder doc version history
Returns the active working lineage of this record's builder doc, newest first, plus publish/working status. Compacted and orphaned versions are omitted.
- Read
Get a builder doc version
Returns one version, including its node tree. The version must belong to this record's builder doc; compacted/orphaned versions are still fetchable by id.
- Read
Run WCAG 2.1 AA accessibility check
Audits the working version of this record's builder doc (and its style guide) for WCAG 2.1 AA issues: color contrast (text vs background on palette roles and color styles), missing image alt text, heading hierarchy, and keyboard/focus risks in HTML sections.
- Write
Create a doc
POST /api/v2/docs
- Write
Update a doc
PATCH /api/v2/docs/{id}
- Write
Create a builder doc node
Adds a new node to the tree under the given parent. Pass publishchanges: true to publish the working version immediately.
- Write
Update a builder doc node
Partial update — only the keys you pass are merged into the node. Settings are deep-merged. Pass publishchanges: true to publish the working version immediately.
- Write
Unlink a global block instance
Detaches a live-linked global block instance into a normal local section (copies current block content into the page). Mirrors the builder Unlink control. Only valid for global block instances.
- Write
Generate embed markup for a node type
Returns a custom element markup string that you can paste into the html of an htmlsection to embed a structured builder node (e.g. an order form, input field, button, signup form, etc.) inside free-form HTML. How to use: 1.
- Write
Create or update HTML section content
Create or update the HTML content of an htmlsection node. nodeid is required. Pass either: The id of an existing htmlsection node — updates its HTML. The literal string "createnew" — creates a new htmlsection node under the root with the given html.
- Write
Publish the working version
Publishes the current working version of this record's builder doc, making staged changes live. Fails when the working draft is disconnected from the published version — POST builder/content/discardunpublishedchanges first.
- Write
Restore a builder doc version
Creates a new working draft whose content matches the given version. Does not publish. The restored snapshot is always a new version on top of the current working version (same as Restore this version in the editor).
- Write
Discard unpublished builder doc changes
Throws away the working draft and reconnects working to the currently published version. This is the operation that repairs a disconnected working lineage so publish can succeed. No-op-success when working is already the published version.
- Destructive
Delete a builder doc node
Removes a node from the tree. Pass publishchanges: true to publish the working version immediately.
- Destructive
Delete Doc
POST /api/v2/docs/{id}/actions/delete
Email Bounces
- Read
List bounced emails
GET /api/v2/email_bounces
- Read
Get a bounced email
GET /api/v2/email_bounces/{id}
Email Domains
- Read
List email domains
GET /api/v2/email_domains
- Read
Get a email domain
GET /api/v2/email_domains/{id}
Email Templates
- Read
List email designs
GET /api/v2/email_templates
- Read
Get a email design
GET /api/v2/email_templates/{id}
- Write
Create a email design
POST /api/v2/email_templates
- Write
Update a email design
PATCH /api/v2/email_templates/{id}
- Write
Add labels
POST /api/v2/email_templates/{id}/actions/add_labels
- Write
Duplicate
POST /api/v2/email_templates/{id}/actions/duplicate
- Write
Make default
POST /api/v2/email_templates/{id}/actions/make_default
- Destructive
Remove label
POST /api/v2/email_templates/{id}/actions/remove_label
Event Occurrence Participants
- Read
List event participants
GET /api/v2/event_occurrence_participants
- Read
Get a event participant
GET /api/v2/event_occurrence_participants/{id}
- Write
Approve registration
POST /api/v2/event_occurrence_participants/{id}/actions/approve_registration
- Write
Waitlist registration
POST /api/v2/event_occurrence_participants/{id}/actions/waitlist_registration
- Write
Deny registration
POST /api/v2/event_occurrence_participants/{id}/actions/deny_registration
- Write
Resend confirmation email
POST /api/v2/event_occurrence_participants/{id}/actions/resend_confirmation_email
- Write
Set Deal Assignee to the organizer on the Scheduling Link
POST /api/v2/event_occurrence_participants/{id}/actions/set_deal_assignee_to_scheduling_link_organizer
- Write
Move to another occurrence
POST /api/v2/event_occurrence_participants/{id}/actions/move_to_occurrence
- Write
Disassociate from funnel
POST /api/v2/event_occurrence_participants/{id}/actions/disassociate_from_funnel
- Destructive
Cancel registration
POST /api/v2/event_occurrence_participants/{id}/actions/cancel_registration
- Destructive
Cancel booking
POST /api/v2/event_occurrence_participants/{id}/actions/cancel_booking
Event Occurrences
- Read
List event occurrences
GET /api/v2/event_occurrences
- Read
Get a event occurrence
GET /api/v2/event_occurrences/{id}
- Write
Update a event occurrence
PATCH /api/v2/event_occurrences/{id}
- Write
Add labels
POST /api/v2/event_occurrences/{id}/actions/add_labels
- Write
Add facet values
POST /api/v2/event_occurrences/{id}/actions/add_facet_values
- Write
Change organizer
POST /api/v2/event_occurrences/{id}/actions/change_organizer
- Write
Duplicate
POST /api/v2/event_occurrences/{id}/actions/duplicate
- Write
Create recording lesson
POST /api/v2/event_occurrences/{id}/actions/create_recording_lesson
- Destructive
Remove label
POST /api/v2/event_occurrences/{id}/actions/remove_label
- Destructive
Remove facet values
POST /api/v2/event_occurrences/{id}/actions/remove_facet_values
Events
- Read
List events
GET /api/v2/events
- Read
Get a event
GET /api/v2/events/{id}
- Write
Create a event
POST /api/v2/events
- Write
Update a event
PATCH /api/v2/events/{id}
- Write
Add facet values
POST /api/v2/events/{id}/actions/add_facet_values
- Write
Add labels
POST /api/v2/events/{id}/actions/add_labels
- Write
Add event series to site(s)
POST /api/v2/events/{id}/actions/add_to_site
- Write
Disassociate from funnel
POST /api/v2/events/{id}/actions/disassociate_from_funnel
- Write
Duplicate
POST /api/v2/events/{id}/actions/duplicate
- Destructive
Remove facet values
POST /api/v2/events/{id}/actions/remove_facet_values
- Destructive
Remove label
POST /api/v2/events/{id}/actions/remove_label
- Destructive
Remove event series from site(s)
POST /api/v2/events/{id}/actions/remove_from_site
Facet Values
- Read
List facet values
GET /api/v2/facet_values
- Read
Get a facet value
GET /api/v2/facet_values/{id}
- Write
Create a facet value
POST /api/v2/facet_values
- Write
Update a facet value
PATCH /api/v2/facet_values/{id}
Facetings
- Read
List facetings
GET /api/v2/facetings
- Read
Get a faceting
GET /api/v2/facetings/{id}
- Write
Create a faceting
POST /api/v2/facetings
Facets
- Read
List facets
GET /api/v2/facets
- Read
Get a facet
GET /api/v2/facets/{id}
- Write
Create a facet
POST /api/v2/facets
- Write
Update a facet
PATCH /api/v2/facets/{id}
- Write
Add labels
POST /api/v2/facets/{id}/actions/add_labels
- Write
Order values alphabetically
POST /api/v2/facets/{id}/actions/order_values_alphabetically
- Destructive
Remove label
POST /api/v2/facets/{id}/actions/remove_label
Field Option Values
- Read
List field option values
GET /api/v2/field_option_values
- Read
Get a field option value
GET /api/v2/field_option_values/{id}
Field Options
- Read
List options
GET /api/v2/field_options
- Read
Get a option
GET /api/v2/field_options/{id}
- Write
Create a option
POST /api/v2/field_options
- Write
Update a option
PATCH /api/v2/field_options/{id}
- Write
Resurrect
POST /api/v2/field_options/{id}/actions/resurrect
Field Values
- Read
List field values
GET /api/v2/field_values
- Read
Get a field value
GET /api/v2/field_values/{id}
- Write
Create a field value
POST /api/v2/field_values
- Write
Update a field value
PATCH /api/v2/field_values/{id}
Fields
- Read
List custom fields
GET /api/v2/fields
- Read
Get a custom field
GET /api/v2/fields/{id}
- Write
Create a custom field
POST /api/v2/fields
- Write
Update a custom field
PATCH /api/v2/fields/{id}
Form Fields
- Read
List fields
GET /api/v2/form_fields
- Read
Get a field
GET /api/v2/form_fields/{id}
- Write
Create a field
POST /api/v2/form_fields
- Write
Update a field
PATCH /api/v2/form_fields/{id}
- Write
Duplicate
POST /api/v2/form_fields/{id}/actions/duplicate
Forum Categories
- Read
List categories
GET /api/v2/forum_categories
- Read
Get a category
GET /api/v2/forum_categories/{id}
- Write
Update a category
PATCH /api/v2/forum_categories/{id}
Forum Posts
- Read
List forum posts
GET /api/v2/forum_posts
- Read
Get a forum post
GET /api/v2/forum_posts/{id}
- Write
Create a forum post
POST /api/v2/forum_posts
- Write
Update a forum post
PATCH /api/v2/forum_posts/{id}
- Write
Reject with message
POST /api/v2/forum_posts/{id}/actions/reject_with_message
- Write
Add facet values
POST /api/v2/forum_posts/{id}/actions/add_facet_values
- Write
Duplicate
POST /api/v2/forum_posts/{id}/actions/duplicate
- Write
Approve
POST /api/v2/forum_posts/{id}/actions/approve
- Write
Reject
POST /api/v2/forum_posts/{id}/actions/reject
- Write
Change category
POST /api/v2/forum_posts/{id}/actions/change_category
- Destructive
Remove facet values
POST /api/v2/forum_posts/{id}/actions/remove_facet_values
Funnel Connectors
- Read
List funnel connectors
GET /api/v2/funnel_connectors
- Read
Get a funnel connector
GET /api/v2/funnel_connectors/{id}
- Write
Add a branch to a split or condition step
Adds a new empty branch (connector) to a splittest or condition step. The new connector goes from parentid (the split/condition step) to that step's paired join step, marked createdblank: true. Fill the branch by creating steps with connectorid set to this connector's id.
- Write
Update a funnel connector
PATCH /api/v2/funnel_connectors/{id}
- Destructive
Delete a funnel connector
Removes a branch from a split or condition step. The branch must be empty — remove any steps inside it first via POST /api/v2/funnelsteps/:id/actions/archive. Cannot delete the otherwise branch, or the last remaining non-otherwise branch.
Funnel Steps
- Read
List funnel steps
GET /api/v2/funnel_steps
- Read
Get a funnel step
GET /api/v2/funnel_steps/{id}
- Write
Create a funnel step
Create a new step in a funnel. The step is graph-aware: for splittest / condition step types, the paired join step and minimum connectors are created atomically.
- Write
Update a funnel step
PATCH /api/v2/funnel_steps/{id}
- Write
Move
POST /api/v2/funnel_steps/{id}/actions/move
- Write
Duplicate
POST /api/v2/funnel_steps/{id}/actions/duplicate
- Write
Restore
POST /api/v2/funnel_steps/{id}/actions/restore
- Write
Duplicate to a new split branch
POST /api/v2/funnel_steps/{id}/actions/duplicate_to_new_branch
- Write
Duplicate to the otherwise branch
POST /api/v2/funnel_steps/{id}/actions/duplicate_to_otherwise_branch
- Write
Duplicate to another funnel
POST /api/v2/funnel_steps/{id}/actions/duplicate_to_funnel
- Write
Split test this step
POST /api/v2/funnel_steps/{id}/actions/split_test
- Write
Reset to the funnel style guide
POST /api/v2/funnel_steps/{id}/actions/reset_style_guide
- Destructive
Archive
POST /api/v2/funnel_steps/{id}/actions/archive
Funnels
- Read
List funnels
GET /api/v2/funnels
- Read
Get a funnel
GET /api/v2/funnels/{id}
- Write
Create a funnel
POST /api/v2/funnels
- Write
Update a funnel
PATCH /api/v2/funnels/{id}
- Write
Resurrect
POST /api/v2/funnels/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/funnels/{id}/actions/add_labels
- Write
Star
POST /api/v2/funnels/{id}/actions/star
- Write
Unstar
POST /api/v2/funnels/{id}/actions/unstar
- Write
Duplicate
POST /api/v2/funnels/{id}/actions/duplicate
- Destructive
Remove label
POST /api/v2/funnels/{id}/actions/remove_label
Ideas
- Read
List ideas
GET /api/v2/ideas
- Read
Get a idea
GET /api/v2/ideas/{id}
- Write
Update a idea
PATCH /api/v2/ideas/{id}
- Write
Move to pipeline stage
POST /api/v2/ideas/{id}/actions/move_to_stage
- Write
Move to pipeline
POST /api/v2/ideas/{id}/actions/move_to_pipeline
- Write
Add facet values
POST /api/v2/ideas/{id}/actions/add_facet_values
- Write
Assign to me
POST /api/v2/ideas/{id}/actions/assign_to_me
- Write
Reassign
POST /api/v2/ideas/{id}/actions/reassign
- Write
Send to Linear
POST /api/v2/ideas/{id}/actions/send_to_linear
- Write
Merge into another idea
POST /api/v2/ideas/{id}/actions/merge
- Destructive
Remove facet values
POST /api/v2/ideas/{id}/actions/remove_facet_values
Installments
- Read
List installments
GET /api/v2/installments
- Read
Get a installment
GET /api/v2/installments/{id}
- Write
Create a installment
POST /api/v2/installments
- Write
Update a installment
PATCH /api/v2/installments/{id}
Labelings
- Read
List labeled objects
GET /api/v2/labelings
- Read
Get a labeled object
GET /api/v2/labelings/{id}
- Write
Create a labeled object
POST /api/v2/labelings
Labels
- Read
List labels
GET /api/v2/labels
- Read
Get a label
GET /api/v2/labels/{id}
- Write
Create a label
POST /api/v2/labels
- Write
Update a label
PATCH /api/v2/labels/{id}
- Write
Star
POST /api/v2/labels/{id}/actions/star
- Write
Unstar
POST /api/v2/labels/{id}/actions/unstar
Landing Pages
- Read
List landing pages
GET /api/v2/landing_pages
- Read
Get a landing page
GET /api/v2/landing_pages/{id}
- Read
List available builder node types
Returns node types that can be added to this builder doc. If parentnodeid is given, filters to types valid as children of that node.
- Read
Get builder node type schema
Returns the list of settings available on a single node type. Type is passed as a query param because it may contain slashes. To get the full args schema (defaults, types) for a specific setting, call the nodetypes/settingsdetail endpoint with the setting ids you care about.
- Read
Get builder node type settings detail
Returns the full args schema (defaults, types) for one or more settings of a given node type. Scoped by the node type. Returns a hash keyed by setting id.
- Read
Get the builder doc node tree
Returns the full working-version node tree for this record.
- Read
Get a builder doc node
Returns a single node by id from the working version.
- Read
Get HTML section content
Returns the HTML content of the htmlsection node with the given id.
- Read
List builder doc version history
Returns the active working lineage of this record's builder doc, newest first, plus publish/working status. Compacted and orphaned versions are omitted.
- Read
Get a builder doc version
Returns one version, including its node tree. The version must belong to this record's builder doc; compacted/orphaned versions are still fetchable by id.
- Read
Run WCAG 2.1 AA accessibility check
Audits the working version of this record's builder doc (and its style guide) for WCAG 2.1 AA issues: color contrast (text vs background on palette roles and color styles), missing image alt text, heading hierarchy, and keyboard/focus risks in HTML sections.
- Write
Create a landing page
POST /api/v2/landing_pages
- Write
Update a landing page
PATCH /api/v2/landing_pages/{id}
- Write
Create a builder doc node
Adds a new node to the tree under the given parent. Pass publishchanges: true to publish the working version immediately.
- Write
Update a builder doc node
Partial update — only the keys you pass are merged into the node. Settings are deep-merged. Pass publishchanges: true to publish the working version immediately.
- Write
Unlink a global block instance
Detaches a live-linked global block instance into a normal local section (copies current block content into the page). Mirrors the builder Unlink control. Only valid for global block instances.
- Write
Generate embed markup for a node type
Returns a custom element markup string that you can paste into the html of an htmlsection to embed a structured builder node (e.g. an order form, input field, button, signup form, etc.) inside free-form HTML. How to use: 1.
- Write
Create or update HTML section content
Create or update the HTML content of an htmlsection node. nodeid is required. Pass either: The id of an existing htmlsection node — updates its HTML. The literal string "createnew" — creates a new htmlsection node under the root with the given html.
- Write
Publish the working version
Publishes the current working version of this record's builder doc, making staged changes live. Fails when the working draft is disconnected from the published version — POST builder/content/discardunpublishedchanges first.
- Write
Restore a builder doc version
Creates a new working draft whose content matches the given version. Does not publish. The restored snapshot is always a new version on top of the current working version (same as Restore this version in the editor).
- Write
Discard unpublished builder doc changes
Throws away the working draft and reconnects working to the currently published version. This is the operation that repairs a disconnected working lineage so publish can succeed. No-op-success when working is already the published version.
- Write
Resurrect
POST /api/v2/landing_pages/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/landing_pages/{id}/actions/add_labels
- Write
Star
POST /api/v2/landing_pages/{id}/actions/star
- Write
Unstar
POST /api/v2/landing_pages/{id}/actions/unstar
- Write
Move to funnel
POST /api/v2/landing_pages/{id}/actions/move_to_funnel
- Write
Move to Site Page
POST /api/v2/landing_pages/{id}/actions/move_to_site
- Write
Undo move to landing page
POST /api/v2/landing_pages/{id}/actions/undo_move
- Write
Convert to Page Builder 2.0
POST /api/v2/landing_pages/{id}/actions/convert_to_builder_v2
- Write
Save as template
POST /api/v2/landing_pages/{id}/actions/save_as_template
- Write
Duplicate
POST /api/v2/landing_pages/{id}/actions/duplicate
- Write
Reset stats
POST /api/v2/landing_pages/{id}/actions/reset_stats
- Write
Refresh page speed score
POST /api/v2/landing_pages/{id}/actions/refresh_page_speed_score
- Destructive
Delete a builder doc node
Removes a node from the tree. Pass publishchanges: true to publish the working version immediately.
- Destructive
Remove label
POST /api/v2/landing_pages/{id}/actions/remove_label
Library Mailings
- Read
List library emails
GET /api/v2/library_mailings
- Read
Get a library email
GET /api/v2/library_mailings/{id}
- Write
Create a library email
POST /api/v2/library_mailings
- Write
Update a library email
PATCH /api/v2/library_mailings/{id}
- Write
Add labels
POST /api/v2/library_mailings/{id}/actions/add_labels
- Write
Duplicate
POST /api/v2/library_mailings/{id}/actions/duplicate
- Write
Send to
POST /api/v2/library_mailings/{id}/actions/send_to
- Write
Add to newsletter queue
POST /api/v2/library_mailings/{id}/actions/add_to_newsletter
- Write
Resurrect
POST /api/v2/library_mailings/{id}/actions/resurrect
- Write
Star
POST /api/v2/library_mailings/{id}/actions/star
- Write
Unstar
POST /api/v2/library_mailings/{id}/actions/unstar
- Write
Use as broadcast
POST /api/v2/library_mailings/{id}/actions/use_as_broadcast
- Write
Save to email library
POST /api/v2/library_mailings/{id}/actions/save_to_library
- Destructive
Remove label
POST /api/v2/library_mailings/{id}/actions/remove_label
Lists
- Read
List lists
GET /api/v2/lists
- Read
Get a list
GET /api/v2/lists/{id}
- Write
Create a list
POST /api/v2/lists
- Write
Update a list
PATCH /api/v2/lists/{id}
- Write
Resurrect
POST /api/v2/lists/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/lists/{id}/actions/add_labels
- Write
Star
POST /api/v2/lists/{id}/actions/star
- Write
Unstar
POST /api/v2/lists/{id}/actions/unstar
- Write
Duplicate
POST /api/v2/lists/{id}/actions/duplicate
- Write
Make main list
POST /api/v2/lists/{id}/actions/make_main
- Destructive
Remove label
POST /api/v2/lists/{id}/actions/remove_label
Mailing Deliveries
- Read
List email deliveries
GET /api/v2/mailing_deliveries
- Read
Get a email delivery
GET /api/v2/mailing_deliveries/{id}
Membership Level Groups
- Read
List membership level groups
GET /api/v2/membership_level_groups
- Read
Get a membership level group
GET /api/v2/membership_level_groups/{id}
- Write
Create a membership level group
POST /api/v2/membership_level_groups
- Write
Update a membership level group
PATCH /api/v2/membership_level_groups/{id}
Nav List Links
Nav Lists
Not Found Requests
- Read
List not found requests
GET /api/v2/not_found_requests
- Read
Get a not found request
GET /api/v2/not_found_requests/{id}
- Write
Create redirect
POST /api/v2/not_found_requests/{id}/actions/create_redirect
Notices
- Read
List notices
GET /api/v2/notices
- Read
Get a notice
GET /api/v2/notices/{id}
- Write
Create a notice
POST /api/v2/notices
- Write
Update a notice
PATCH /api/v2/notices/{id}
- Write
Add labels
POST /api/v2/notices/{id}/actions/add_labels
- Destructive
Remove label
POST /api/v2/notices/{id}/actions/remove_label
Nps Scores
- Read
List net promoter scores
GET /api/v2/nps_scores
- Read
Get a net promoter score
GET /api/v2/nps_scores/{id}
Nps Surveys
- Read
List nps surveys
GET /api/v2/nps_surveys
- Read
Get a nps survey
GET /api/v2/nps_surveys/{id}
- Write
Update a nps survey
PATCH /api/v2/nps_surveys/{id}
Offers
- Read
List upsell offers
GET /api/v2/offers
- Read
Get a upsell offer
GET /api/v2/offers/{id}
- Write
Create a upsell offer
POST /api/v2/offers
- Write
Update a upsell offer
PATCH /api/v2/offers/{id}
- Write
Resurrect
POST /api/v2/offers/{id}/actions/resurrect
Opt Ins
- Read
List opt-ins
GET /api/v2/opt_ins
- Read
Get a opt-in
GET /api/v2/opt_ins/{id}
Order Bumps
- Read
List order bumps
GET /api/v2/order_bumps
- Read
Get a order bump
GET /api/v2/order_bumps/{id}
- Write
Create a order bump
POST /api/v2/order_bumps
- Write
Update a order bump
PATCH /api/v2/order_bumps/{id}
- Write
Copy
POST /api/v2/order_bumps/{id}/actions/copy
Pages
- Read
List pages
GET /api/v2/pages
- Read
Get a page
GET /api/v2/pages/{id}
- Read
List available builder node types
Returns node types that can be added to this builder doc. If parentnodeid is given, filters to types valid as children of that node.
- Read
Get builder node type schema
Returns the list of settings available on a single node type. Type is passed as a query param because it may contain slashes. To get the full args schema (defaults, types) for a specific setting, call the nodetypes/settingsdetail endpoint with the setting ids you care about.
- Read
Get builder node type settings detail
Returns the full args schema (defaults, types) for one or more settings of a given node type. Scoped by the node type. Returns a hash keyed by setting id.
- Read
Get the builder doc node tree
Returns the full working-version node tree for this record.
- Read
Get a builder doc node
Returns a single node by id from the working version.
- Read
Get HTML section content
Returns the HTML content of the htmlsection node with the given id.
- Read
List builder doc version history
Returns the active working lineage of this record's builder doc, newest first, plus publish/working status. Compacted and orphaned versions are omitted.
- Read
Get a builder doc version
Returns one version, including its node tree. The version must belong to this record's builder doc; compacted/orphaned versions are still fetchable by id.
- Read
Run WCAG 2.1 AA accessibility check
Audits the working version of this record's builder doc (and its style guide) for WCAG 2.1 AA issues: color contrast (text vs background on palette roles and color styles), missing image alt text, heading hierarchy, and keyboard/focus risks in HTML sections.
- Write
Create a page
POST /api/v2/pages
- Write
Update a page
PATCH /api/v2/pages/{id}
- Write
Create a builder doc node
Adds a new node to the tree under the given parent. Pass publishchanges: true to publish the working version immediately.
- Write
Update a builder doc node
Partial update — only the keys you pass are merged into the node. Settings are deep-merged. Pass publishchanges: true to publish the working version immediately.
- Write
Unlink a global block instance
Detaches a live-linked global block instance into a normal local section (copies current block content into the page). Mirrors the builder Unlink control. Only valid for global block instances.
- Write
Generate embed markup for a node type
Returns a custom element markup string that you can paste into the html of an htmlsection to embed a structured builder node (e.g. an order form, input field, button, signup form, etc.) inside free-form HTML. How to use: 1.
- Write
Create or update HTML section content
Create or update the HTML content of an htmlsection node. nodeid is required. Pass either: The id of an existing htmlsection node — updates its HTML. The literal string "createnew" — creates a new htmlsection node under the root with the given html.
- Write
Publish the working version
Publishes the current working version of this record's builder doc, making staged changes live. Fails when the working draft is disconnected from the published version — POST builder/content/discardunpublishedchanges first.
- Write
Restore a builder doc version
Creates a new working draft whose content matches the given version. Does not publish. The restored snapshot is always a new version on top of the current working version (same as Restore this version in the editor).
- Write
Discard unpublished builder doc changes
Throws away the working draft and reconnects working to the currently published version. This is the operation that repairs a disconnected working lineage so publish can succeed. No-op-success when working is already the published version.
- Write
Resurrect
POST /api/v2/pages/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/pages/{id}/actions/add_labels
- Write
Publish
POST /api/v2/pages/{id}/actions/publish
- Write
Unpublish
POST /api/v2/pages/{id}/actions/unpublish
- Write
Drip
POST /api/v2/pages/{id}/actions/drip
- Write
Duplicate
POST /api/v2/pages/{id}/actions/duplicate
- Write
Clone to another site
POST /api/v2/pages/{id}/actions/clone_to_site
- Write
Move to another site
POST /api/v2/pages/{id}/actions/move_to_site
- Write
Move to funnel
POST /api/v2/pages/{id}/actions/move_to_funnel
- Write
Turn into a Landing Page
POST /api/v2/pages/{id}/actions/convert_to_landing_page
- Write
Undo move to site page
POST /api/v2/pages/{id}/actions/undo_move
- Write
Turn into a Funnel
POST /api/v2/pages/{id}/actions/create_funnel_from
- Write
Reset view counters
POST /api/v2/pages/{id}/actions/reset_view_counters
- Write
Hide from search engines
POST /api/v2/pages/{id}/actions/hide_from_bots
- Write
Unhide from search engines
POST /api/v2/pages/{id}/actions/unhide_from_bots
- Write
Toggle search engine visibility
POST /api/v2/pages/{id}/actions/toggle_bots
- Write
Hide from site search
POST /api/v2/pages/{id}/actions/hide_from_site_search
- Write
Include in site search
POST /api/v2/pages/{id}/actions/unhide_from_site_search
- Write
Toggle site search visibility
POST /api/v2/pages/{id}/actions/toggle_site_search
- Write
Hide from AI crawlers
POST /api/v2/pages/{id}/actions/hide_from_ai_bots
- Write
Unhide from AI crawlers
POST /api/v2/pages/{id}/actions/unhide_from_ai_bots
- Write
Toggle AI crawler visibility
POST /api/v2/pages/{id}/actions/toggle_ai_bots
- Write
Make this page the site home page
POST /api/v2/pages/{id}/actions/make_home_page
- Write
Replace with redirect
POST /api/v2/pages/{id}/actions/replace_with_redirect
- Write
Save as template
POST /api/v2/pages/{id}/actions/save_as_template
- Write
Convert to Page Builder 2.0
POST /api/v2/pages/{id}/actions/convert_to_builder_v2
- Write
Refresh page speed score
POST /api/v2/pages/{id}/actions/refresh_page_speed_score
- Destructive
Delete a builder doc node
Removes a node from the tree. Pass publishchanges: true to publish the working version immediately.
- Destructive
Remove label
POST /api/v2/pages/{id}/actions/remove_label
Pipeline Stages
- Read
List pipeline stages
GET /api/v2/pipeline_stages
- Read
Get a pipeline stage
GET /api/v2/pipeline_stages/{id}
- Write
Create a pipeline stage
POST /api/v2/pipeline_stages
- Write
Update a pipeline stage
PATCH /api/v2/pipeline_stages/{id}
Pipelines
- Read
List pipelines
GET /api/v2/pipelines
- Read
Get a pipeline
GET /api/v2/pipelines/{id}
- Write
Create a pipeline
POST /api/v2/pipelines
- Write
Update a pipeline
PATCH /api/v2/pipelines/{id}
- Write
Add labels
POST /api/v2/pipelines/{id}/actions/add_labels
- Write
Star
POST /api/v2/pipelines/{id}/actions/star
- Write
Unstar
POST /api/v2/pipelines/{id}/actions/unstar
- Write
Set default
POST /api/v2/pipelines/{id}/actions/set_default
- Destructive
Remove label
POST /api/v2/pipelines/{id}/actions/remove_label
Playlists
- Read
List playlists
GET /api/v2/playlists
- Read
Get a playlist
GET /api/v2/playlists/{id}
Podcast Episodes
- Read
List episodes
GET /api/v2/podcast_episodes
- Read
Get a episode
GET /api/v2/podcast_episodes/{id}
- Write
Create a episode
POST /api/v2/podcast_episodes
- Write
Update a episode
PATCH /api/v2/podcast_episodes/{id}
- Write
Resurrect
POST /api/v2/podcast_episodes/{id}/actions/resurrect
- Write
Publish
POST /api/v2/podcast_episodes/{id}/actions/publish
- Write
Unpublish
POST /api/v2/podcast_episodes/{id}/actions/unpublish
Podcasts
- Read
List podcasts
GET /api/v2/podcasts
- Read
Get a podcast
GET /api/v2/podcasts/{id}
- Write
Create a podcast
POST /api/v2/podcasts
- Write
Update a podcast
PATCH /api/v2/podcasts/{id}
- Write
Resurrect
POST /api/v2/podcasts/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/podcasts/{id}/actions/add_labels
- Destructive
Remove label
POST /api/v2/podcasts/{id}/actions/remove_label
Price Periods
- Read
List price periods
GET /api/v2/price_periods
- Read
Get a price period
GET /api/v2/price_periods/{id}
- Write
Create a price period
POST /api/v2/price_periods
- Write
Update a price period
PATCH /api/v2/price_periods/{id}
Prices
- Read
List prices
GET /api/v2/prices
- Read
Get a price
GET /api/v2/prices/{id}
- Write
Create a price
POST /api/v2/prices
- Write
Update a price
PATCH /api/v2/prices/{id}
- Write
Duplicate
POST /api/v2/prices/{id}/actions/duplicate
- Write
Add a price that overrides this one
POST /api/v2/prices/{id}/actions/add_override
Product Affiliate Programs
- Read
List product affiliate programs
GET /api/v2/product_affiliate_programs
- Read
Get a product affiliate program
GET /api/v2/product_affiliate_programs/{id}
- Write
Create a product affiliate program
POST /api/v2/product_affiliate_programs
- Write
Update a product affiliate program
PATCH /api/v2/product_affiliate_programs/{id}
Product Affiliates
- Read
List product affiliates
GET /api/v2/product_affiliates
- Read
Get a product affiliate
GET /api/v2/product_affiliates/{id}
- Write
Create a product affiliate
POST /api/v2/product_affiliates
- Write
Update a product affiliate
PATCH /api/v2/product_affiliates/{id}
Product Categories
- Read
List categories
GET /api/v2/product_categories
- Read
Get a category
GET /api/v2/product_categories/{id}
- Write
Create a category
POST /api/v2/product_categories
- Write
Update a category
PATCH /api/v2/product_categories/{id}
Product Variants
- Read
List variants
GET /api/v2/product_variants
- Read
Get a variant
GET /api/v2/product_variants/{id}
- Write
Create a variant
POST /api/v2/product_variants
- Write
Update a variant
PATCH /api/v2/product_variants/{id}
Products
- Read
List products
GET /api/v2/products
- Read
Get a product
GET /api/v2/products/{id}
- Read
List
POST /api/v2/products/{id}/actions/list
- Write
Create a product
POST /api/v2/products
- Write
Update a product
PATCH /api/v2/products/{id}
- Write
Resurrect
POST /api/v2/products/{id}/actions/resurrect
- Write
Add content access
POST /api/v2/products/{id}/actions/add_content
- Write
Add facet values
POST /api/v2/products/{id}/actions/add_facet_values
- Write
Add labels
POST /api/v2/products/{id}/actions/add_labels
- Write
Star
POST /api/v2/products/{id}/actions/star
- Write
Unstar
POST /api/v2/products/{id}/actions/unstar
- Write
Reset freebie link
POST /api/v2/products/{id}/actions/reset_freebie_token
- Write
Unlist
POST /api/v2/products/{id}/actions/unlist
- Write
Close
POST /api/v2/products/{id}/actions/close
- Write
Duplicate
POST /api/v2/products/{id}/actions/duplicate
- Destructive
Remove content access
POST /api/v2/products/{id}/actions/remove_content
- Destructive
Remove facet values
POST /api/v2/products/{id}/actions/remove_facet_values
- Destructive
Remove label
POST /api/v2/products/{id}/actions/remove_label
Purchases
- Read
List purchases
GET /api/v2/purchases
- Read
Get a purchase
GET /api/v2/purchases/{id}
- Write
Update next charge on
POST /api/v2/purchases/{id}/actions/update_next_charge_on
- Write
Postpone upcoming charges by
POST /api/v2/purchases/{id}/actions/postpone_upcoming_charges_by
- Write
Update period ends at
POST /api/v2/purchases/{id}/actions/update_period_ends_at
- Write
Postpone period ends at by
POST /api/v2/purchases/{id}/actions/postpone_period_ends_at_by
- Write
Refund
POST /api/v2/purchases/{id}/actions/refund
- Write
Capture
POST /api/v2/purchases/{id}/actions/capture
- Write
Pause
POST /api/v2/purchases/{id}/actions/pause
- Write
Resume
POST /api/v2/purchases/{id}/actions/resume
- Write
Turn off auto renew
POST /api/v2/purchases/{id}/actions/turn_off_auto_renew
- Write
Turn on auto renew
POST /api/v2/purchases/{id}/actions/turn_on_auto_renew
- Write
Move to another product
POST /api/v2/purchases/{id}/actions/move_to_product
- Write
Change tax percent
POST /api/v2/purchases/{id}/actions/change_tax_percent
- Write
Disassociate from funnel
POST /api/v2/purchases/{id}/actions/disassociate_from_funnel
- Write
Set auto responder start at
POST /api/v2/purchases/{id}/actions/set_auto_responder_start_at
- Destructive
Cancel
POST /api/v2/purchases/{id}/actions/cancel
Quiz Answers
- Read
List quiz answers
GET /api/v2/quiz_answers
- Read
Get a quiz answer
GET /api/v2/quiz_answers/{id}
- Write
Create a quiz answer
POST /api/v2/quiz_answers
- Write
Update a quiz answer
PATCH /api/v2/quiz_answers/{id}
- Write
Resurrect
POST /api/v2/quiz_answers/{id}/actions/resurrect
Quiz Questions
- Read
List quiz questions
GET /api/v2/quiz_questions
- Read
Get a quiz question
GET /api/v2/quiz_questions/{id}
- Write
Create a quiz question
POST /api/v2/quiz_questions
- Write
Update a quiz question
PATCH /api/v2/quiz_questions/{id}
- Write
Resurrect
POST /api/v2/quiz_questions/{id}/actions/resurrect
Quiz Responses
- Read
List responses
GET /api/v2/quiz_responses
- Read
Get a response
GET /api/v2/quiz_responses/{id}
Scheduling Link Availability Overrides
- Read
List scheduling link availability overrides
GET /api/v2/scheduling_link_availability_overrides
- Read
Get a scheduling link availability override
GET /api/v2/scheduling_link_availability_overrides/{id}
- Write
Create a scheduling link availability override
POST /api/v2/scheduling_link_availability_overrides
- Write
Update a scheduling link availability override
PATCH /api/v2/scheduling_link_availability_overrides/{id}
Scheduling Links
- Read
List scheduling links
GET /api/v2/scheduling_links
- Read
Get a scheduling link
GET /api/v2/scheduling_links/{id}
- Write
Create a scheduling link
POST /api/v2/scheduling_links
- Write
Update a scheduling link
PATCH /api/v2/scheduling_links/{id}
- Write
Add labels
POST /api/v2/scheduling_links/{id}/actions/add_labels
- Write
Star
POST /api/v2/scheduling_links/{id}/actions/star
- Write
Unstar
POST /api/v2/scheduling_links/{id}/actions/unstar
- Write
Duplicate
POST /api/v2/scheduling_links/{id}/actions/duplicate
- Write
Add child links
POST /api/v2/scheduling_links/{id}/actions/attach_children
- Write
Reorder child links
POST /api/v2/scheduling_links/{id}/actions/reorder_children
- Destructive
Remove label
POST /api/v2/scheduling_links/{id}/actions/remove_label
- Destructive
Remove child link
POST /api/v2/scheduling_links/{id}/actions/remove_child
Segments
- Read
List segments
GET /api/v2/segments
- Read
Get a segment
GET /api/v2/segments/{id}
- Write
Update a segment
PATCH /api/v2/segments/{id}
- Write
Resurrect
POST /api/v2/segments/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/segments/{id}/actions/add_labels
- Write
Star
POST /api/v2/segments/{id}/actions/star
- Write
Unstar
POST /api/v2/segments/{id}/actions/unstar
- Write
Refresh
POST /api/v2/segments/{id}/actions/refresh
- Write
Duplicate
POST /api/v2/segments/{id}/actions/duplicate
- Destructive
Remove label
POST /api/v2/segments/{id}/actions/remove_label
Short Links
- Read
List shortlinks
GET /api/v2/short_links
- Read
Get a shortlink
GET /api/v2/short_links/{id}
- Write
Create a shortlink
POST /api/v2/short_links
- Write
Update a shortlink
PATCH /api/v2/short_links/{id}
- Write
Add labels
POST /api/v2/short_links/{id}/actions/add_labels
- Write
Reset visits
POST /api/v2/short_links/{id}/actions/reset_visits
- Destructive
Remove label
POST /api/v2/short_links/{id}/actions/remove_label
Site Comments
- Read
List comments
GET /api/v2/site_comments
- Read
Get a comment
GET /api/v2/site_comments/{id}
- Write
Create a site comment
Creates a comment, or a reply, on a course lesson, community post, blog post, or idea. memberid is the SiteMember who posts; see the field for the rules. body is HTML. Comments by staff and admins are approved right away and notify subscribers.
- Write
React to a site comment
Adds an emoji reaction to an approved site comment. Adding the same reaction again does nothing. memberid is the SiteMember who reacts. It follows the same rules as when creating a comment. Returns 422 when reactions are turned off for that item.
- Write
Resurrect
POST /api/v2/site_comments/{id}/actions/resurrect
- Write
Reject with message
POST /api/v2/site_comments/{id}/actions/reject_with_message
- Write
Approve
POST /api/v2/site_comments/{id}/actions/approve
- Write
Reject
POST /api/v2/site_comments/{id}/actions/reject
- Write
Send to Linear
POST /api/v2/site_comments/{id}/actions/send_to_linear
Site Redirects
- Read
List redirects
GET /api/v2/site_redirects
- Read
Get a redirect
GET /api/v2/site_redirects/{id}
- Write
Create a redirect
POST /api/v2/site_redirects
- Write
Update a redirect
PATCH /api/v2/site_redirects/{id}
- Write
Make permanent
POST /api/v2/site_redirects/{id}/actions/make_permanent
- Write
Make temporary
POST /api/v2/site_redirects/{id}/actions/make_temporary
Sites
- Read
List sites
GET /api/v2/sites
- Read
Get a site
GET /api/v2/sites/{id}
- Write
Create a site
POST /api/v2/sites
- Write
Update a site
PATCH /api/v2/sites/{id}
- Write
Resurrect
POST /api/v2/sites/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/sites/{id}/actions/add_labels
- Write
Star
POST /api/v2/sites/{id}/actions/star
- Write
Unstar
POST /api/v2/sites/{id}/actions/unstar
- Write
Turn a site feature on or off
POST /api/v2/sites/{id}/actions/set_feature
- Write
Reindex
POST /api/v2/sites/{id}/actions/reindex
- Write
Enable AI search and interactions
POST /api/v2/sites/{id}/actions/enable_chat_bot
- Write
Disable AI search and interactions
POST /api/v2/sites/{id}/actions/disable_chat_bot
- Write
Add member
POST /api/v2/sites/{id}/actions/grant_access
- Destructive
Remove label
POST /api/v2/sites/{id}/actions/remove_label
Step Paths
- Read
Get a split branch
GET /api/v2/step_paths/{id}
- Read
List split branches
GET /api/v2/step_paths
- Write
Update a split branch
PATCH /api/v2/step_paths/{id}
- Write
Create a split branch
POST /api/v2/step_paths
- Write
Resurrect
POST /api/v2/step_paths/{id}/actions/resurrect
- Destructive
Delete a split branch
Removes a branch from its split, together with every step in it. Contacts waiting in those steps move on to the step after the split. In a split test the remaining branches keep their percentages and the last one takes the freed share.
Steps
- Read
Get a automation step
GET /api/v2/steps/{id}
- Read
List automation steps
GET /api/v2/steps
- Write
Update a automation step
PATCH /api/v2/steps/{id}
- Write
Create a automation step
POST /api/v2/steps
- Write
Resurrect
POST /api/v2/steps/{id}/actions/resurrect
- Write
Move
POST /api/v2/steps/{id}/actions/move
- Write
Enable
POST /api/v2/steps/{id}/actions/enable
- Write
Disable
POST /api/v2/steps/{id}/actions/disable
- Write
Skip if previous wait exceeded
POST /api/v2/steps/{id}/actions/skip_if_wait_exceeded
- Write
Don't skip if previous wait exceeded
POST /api/v2/steps/{id}/actions/dont_skip_if_wait_exceeded
- Write
Duplicate
POST /api/v2/steps/{id}/actions/duplicate_steps
- Write
Copy to another automation
POST /api/v2/steps/{id}/actions/copy_to_automation
- Write
Continue waiting contacts now
POST /api/v2/steps/{id}/actions/continue_flows_now
- Write
Move contacts in this step to another step
POST /api/v2/steps/{id}/actions/move_flows
- Destructive
Delete a automation step
Removes a step from its automation. The steps after it move up to follow the step before it. Contacts currently waiting in the step continue from the next step, or finish if there is none. Goto steps that point at the deleted step will no longer have a target.
- Destructive
Delete
POST /api/v2/steps/{id}/actions/delete_steps
Subscriptions
- Read
List list subscriptions
GET /api/v2/subscriptions
- Read
Get a list subscription
GET /api/v2/subscriptions/{id}
- Write
Unsubscribe
POST /api/v2/subscriptions/{id}/actions/unsubscribe
- Write
Resend email asking for confirmation
POST /api/v2/subscriptions/{id}/actions/request_confirmation
- Write
Suspend
POST /api/v2/subscriptions/{id}/actions/suspend
- Write
Resume
POST /api/v2/subscriptions/{id}/actions/resume
- Write
Force activate
POST /api/v2/subscriptions/{id}/actions/force_activate
- Write
Resubscribe
POST /api/v2/subscriptions/{id}/actions/resubscribe
- Write
Resend welcome email
POST /api/v2/subscriptions/{id}/actions/resend_welcome
- Write
Set auto responder start at
POST /api/v2/subscriptions/{id}/actions/set_auto_responder_start_at
- Write
Set Affiliate for List Subscriber
POST /api/v2/subscriptions/{id}/actions/set_affiliate
- Write
Disassociate from funnel
POST /api/v2/subscriptions/{id}/actions/disassociate_from_funnel
- Destructive
Remove Affiliate for List Subscriber
POST /api/v2/subscriptions/{id}/actions/remove_affiliate
Survey Responses
- Read
List survey responses
GET /api/v2/survey_responses
- Read
Get a survey response
GET /api/v2/survey_responses/{id}
- Write
Create a survey response
POST /api/v2/survey_responses
- Write
Update a survey response
PATCH /api/v2/survey_responses/{id}
- Write
Post message to conversation
POST /api/v2/survey_responses/{id}/actions/post_to_conversation
- Write
Add to conversation
POST /api/v2/survey_responses/{id}/actions/add_to_conversation
- Write
Associate with Contact
POST /api/v2/survey_responses/{id}/actions/associate_contact
- Write
Disassociate from funnel
POST /api/v2/survey_responses/{id}/actions/disassociate_from_funnel
Surveys
- Read
List surveys
GET /api/v2/surveys
- Read
Get a survey
GET /api/v2/surveys/{id}
- Write
Create a survey
POST /api/v2/surveys
- Write
Update a survey
PATCH /api/v2/surveys/{id}
- Write
Resurrect
POST /api/v2/surveys/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/surveys/{id}/actions/add_labels
- Write
Star
POST /api/v2/surveys/{id}/actions/star
- Write
Unstar
POST /api/v2/surveys/{id}/actions/unstar
- Write
Duplicate
POST /api/v2/surveys/{id}/actions/duplicate
- Destructive
Remove label
POST /api/v2/surveys/{id}/actions/remove_label
Taggings
- Read
List tagged contacts
GET /api/v2/taggings
- Read
Get a tagged contact
GET /api/v2/taggings/{id}
- Write
Create a tagged contact
POST /api/v2/taggings
Tags
- Read
List tags
GET /api/v2/tags
- Read
Get a tag
GET /api/v2/tags/{id}
- Write
Create a tag
POST /api/v2/tags
- Write
Update a tag
PATCH /api/v2/tags/{id}
- Write
Add labels
POST /api/v2/tags/{id}/actions/add_labels
- Write
Star
POST /api/v2/tags/{id}/actions/star
- Write
Unstar
POST /api/v2/tags/{id}/actions/unstar
- Write
Rename
POST /api/v2/tags/{id}/actions/rename
- Destructive
Remove label
POST /api/v2/tags/{id}/actions/remove_label
Testimonials
- Read
List testimonials
GET /api/v2/testimonials
- Read
Get a testimonial
GET /api/v2/testimonials/{id}
- Write
Create a testimonial
POST /api/v2/testimonials
- Write
Update a testimonial
PATCH /api/v2/testimonials/{id}
- Write
Add labels
POST /api/v2/testimonials/{id}/actions/add_labels
- Write
Publish
POST /api/v2/testimonials/{id}/actions/publish
- Write
Unpublish
POST /api/v2/testimonials/{id}/actions/unpublish
- Destructive
Remove label
POST /api/v2/testimonials/{id}/actions/remove_label
Ticket Comments
- Read
List ticket comments
GET /api/v2/ticket_comments
- Read
Get a ticket comment
GET /api/v2/ticket_comments/{id}
- Write
Create a ticket comment
POST /api/v2/ticket_comments
- Write
Resurrect
POST /api/v2/ticket_comments/{id}/actions/resurrect
Tickets
- Read
List tickets
GET /api/v2/tickets
- Read
Get a ticket
GET /api/v2/tickets/{id}
- Write
Create a ticket
POST /api/v2/tickets
- Write
Update a ticket
PATCH /api/v2/tickets/{id}
- Write
Resurrect
POST /api/v2/tickets/{id}/actions/resurrect
- Write
Add facet values
POST /api/v2/tickets/{id}/actions/add_facet_values
- Write
Move to pipeline stage
POST /api/v2/tickets/{id}/actions/move_to_stage
- Write
Move to pipeline
POST /api/v2/tickets/{id}/actions/move_to_pipeline
- Write
Add comment
POST /api/v2/tickets/{id}/actions/add_comment
- Write
Unlock
POST /api/v2/tickets/{id}/actions/unlock
- Write
Mark as unread by assignee
POST /api/v2/tickets/{id}/actions/mark_unread
- Write
Mark as read by assignee
POST /api/v2/tickets/{id}/actions/mark_read
- Write
Turn on reassign to default assignee on reply
POST /api/v2/tickets/{id}/actions/turn_on_reassign_on_reply
- Write
Turn off reassign to default assignee on reply
POST /api/v2/tickets/{id}/actions/turn_off_reassign_on_reply
- Write
Add submitter
POST /api/v2/tickets/{id}/actions/add_submitter
- Write
Assign to me
POST /api/v2/tickets/{id}/actions/assign_to_me
- Write
Reassign
POST /api/v2/tickets/{id}/actions/reassign
- Write
Exclude from CSAT reporting
POST /api/v2/tickets/{id}/actions/exclude_from_csat
- Write
Close without requesting a review
POST /api/v2/tickets/{id}/actions/close_silently
- Write
Add a facet
POST /api/v2/tickets/{id}/actions/add_facet
- Destructive
Remove facet values
POST /api/v2/tickets/{id}/actions/remove_facet_values
- Destructive
Remove submitter
POST /api/v2/tickets/{id}/actions/remove_submitter
- Destructive
Remove a facet
POST /api/v2/tickets/{id}/actions/remove_facet
Transactional Emails
- Read
List transactional emails
GET /api/v2/transactional_emails
- Read
Get a transactional email
GET /api/v2/transactional_emails/{id}
Triggers
- Read
List available trigger events for an owner type
Returns the event ids and titles available for a given ownertype (e.g. Tag, Link, Account). Omit ownertype to list events across every owner type. Includes both typed-registry events and legacy events that have not been migrated yet.
- Read
Get the typed args schema for a trigger event
Returns the title and (when available) the typed args schema for an event id. Legacy events that were never migrated to the typed event registry return an empty args.
- Read
List triggers
GET /api/v2/triggers
- Read
Get a trigger
GET /api/v2/triggers/{id}
- Write
Create a trigger
POST /api/v2/triggers
- Write
Update a trigger
PATCH /api/v2/triggers/{id}
- Write
Resurrect
POST /api/v2/triggers/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/triggers/{id}/actions/add_labels
- Write
Duplicate
POST /api/v2/triggers/{id}/actions/duplicate
- Destructive
Remove label
POST /api/v2/triggers/{id}/actions/remove_label
- Destructive
Delete Trigger
POST /api/v2/triggers/{id}/actions/delete
Upsells
- Read
List upsells
GET /api/v2/upsells
- Read
Get a upsell
GET /api/v2/upsells/{id}
- Write
Create a upsell
POST /api/v2/upsells
- Write
Update a upsell
PATCH /api/v2/upsells/{id}
- Write
Resurrect
POST /api/v2/upsells/{id}/actions/resurrect
Verified Emails
- Read
List senders
GET /api/v2/verified_emails
- Read
Get a sender
GET /api/v2/verified_emails/{id}
Worksheet Responses
- Read
List completed worksheets
GET /api/v2/worksheet_responses
- Read
Get a completed worksheet
GET /api/v2/worksheet_responses/{id}
- Write
Resurrect
POST /api/v2/worksheet_responses/{id}/actions/resurrect
- Write
Post message to conversation
POST /api/v2/worksheet_responses/{id}/actions/post_to_conversation
- Write
Add to conversation
POST /api/v2/worksheet_responses/{id}/actions/add_to_conversation
Worksheet Sections
- Read
List worksheet sections
GET /api/v2/worksheet_sections
- Read
Get a worksheet section
GET /api/v2/worksheet_sections/{id}
- Write
Create a worksheet section
POST /api/v2/worksheet_sections
- Write
Update a worksheet section
PATCH /api/v2/worksheet_sections/{id}
- Write
Resurrect
POST /api/v2/worksheet_sections/{id}/actions/resurrect
- Write
Duplicate
POST /api/v2/worksheet_sections/{id}/actions/duplicate
- Destructive
Delete Worksheet section
POST /api/v2/worksheet_sections/{id}/actions/delete
Worksheets
- Read
List worksheets
GET /api/v2/worksheets
- Read
Get a worksheet
GET /api/v2/worksheets/{id}
- Write
Create a worksheet
POST /api/v2/worksheets
- Write
Update a worksheet
PATCH /api/v2/worksheets/{id}
- Write
Resurrect
POST /api/v2/worksheets/{id}/actions/resurrect
- Write
Add labels
POST /api/v2/worksheets/{id}/actions/add_labels
- Write
Activate
POST /api/v2/worksheets/{id}/actions/activate
- Write
Deactivate
POST /api/v2/worksheets/{id}/actions/deactivate
- Write
Duplicate
POST /api/v2/worksheets/{id}/actions/duplicate
- Destructive
Remove label
POST /api/v2/worksheets/{id}/actions/remove_label
Wysiwyg Content Templates
- Read
List macros
GET /api/v2/wysiwyg_content_templates
- Read
Get a macro
GET /api/v2/wysiwyg_content_templates/{id}
- Write
Create a macro
POST /api/v2/wysiwyg_content_templates
- Write
Update a macro
PATCH /api/v2/wysiwyg_content_templates/{id}
- Write
Record usage
POST /api/v2/wysiwyg_content_templates/{id}/actions/record_usage
No operations match.
See How connections work for access and permissions, or browse all integrations.