Skip to main content
Tave logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 129
  • Triggers: 0
  • Slug: TAVE
  • Version: 20261101_00

Tools

Slug: TAVE_APPLY_PAYMENT_TO_ORDERTool to apply a payment to a specific order in Tave. Use when you need to allocate a payment amount to an order for a job.

Input Parameters

string
required
ULID of the payment to apply. This is the unique identifier of the payment that will be applied to the order.
integer
required
Positive numeric representing an amount in the studio’s currency. The amount of the payment to apply to the order.
string
required
ULID of the order to apply the payment to. This is the unique identifier of the order that will receive the payment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_BRANDTool to create a new brand in VSCO Workspace. Use when setting up a new brand identity for client-facing portals and communications.

Input Parameters

string
BCC email address for all outgoing emails from this brand.
string
required
The brand’s name. Must be between 4 and 128 characters.
string
required
Unique alias for the brand URL. Must be between 4 and 32 characters.
object
Brand theme configuration.
object
Brand phone number with label.
object
Brand phone number with label.
object
Brand phone number with label.
string
Reply-to email address for emails sent from this brand.
string
Email address to forward incoming messages to.
string
required
A shorter name for the brand to be used in constrained UI places.
string
ULID identifier of the location associated with this brand.
string
Office hours information text.
string
Custom domain for the brand’s client portal.
array
List of external system mappings for this brand.
boolean
Whether clients can edit their profile information.
string
Google Analytics tracking ID. Must match pattern (UA|YT|MO)-\d+-\d+
string
ULID identifier of the root contact form for this brand.
integer
required
Client access version number. Must be between 1 and 10.
boolean
Whether to show interaction history in the client portal.
boolean
Whether to break out package pricing in client-facing views.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_CUSTOM_FIELDTool to create a custom field in Tave for Jobs or Contacts. Use when you need to add custom data fields to capture additional information specific to your business workflow.

Input Parameters

string ("TextField" | "TextBox" | "DropDown" | "Number" | "Decimal" | "Money" | "Date" | "Time" | "Checkbox")
The type of input field (TextField, TextBox, DropDown, Number, Decimal, Money, Date, Time, Checkbox)
string
required
The name of the custom field
string
A unique token identifier for this custom field
boolean
Whether this custom field should be hidden from view
array
List of choices for DropDown field type. Required when kind is DropDown
string ("Job" | "Contact")
The resource type this field can be applied to (Job or Contact)
string
The label to display to clients when they have access to this field
string ("None" | "Visible" | "Editable")
Client access level for this field (None, Visible, Editable)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_DISCOUNT_TYPETool to create a new discount type in Tave. Use when you need to create a new discount category for organizing discounts. The name field is required and must be 255 characters or less.

Input Parameters

string
required
The name of the discount type (required)
boolean
Whether or not the discount type is hidden. Defaults to false if not provided.
string
A ULID entity identifier for the parent discount type, if any. Set to null for root-level discount types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_ADDRESS_BOOKTool to create an entry in the address book. Use when you need to add a new person, company, or location to the address book.

Input Parameters

string ("person" | "company" | "location")
required
Type of address book entry. Valid values: ‘person’, ‘company’, ‘location’
string
Email address of the contact
string
Last name of the person (for kind=‘person’)
string
First name of the person (for kind=‘person’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_DISCOUNTTool to create a discount in Tave. Use when you need to add a new discount with a name, price, and type ID.

Input Parameters

string
Stock Keeping Unit (SKU) for the discount.
string ("Amount" | "Percent")
Enum for discount kind values.
string
required
The name of the discount.
integer
required
Positive numeric representing an amount in the studio’s currency. For percentage discounts, this represents the percentage value (e.g., 10 for 10%).
boolean
Whether or not the discount is hidden.
boolean
Whether the discount is a rebate. Defaults to false.
string
required
A lowercase ULID entity identifier for the discount type.
boolean
Whether the discount allows manual entry. Defaults to true.
string
HTML description of the discount.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_EVENTTool to create a new event in Tave (VSCO Workspace). Use when scheduling meetings, sessions, or appointments.

Input Parameters

string
Name or title of the event
string
ULID identifier of the associated job
boolean
Whether this is an all-day event
boolean
Whether the event is hidden
string
ULID identifier of the event type
string ("InPerson" | "Phone" | "Virtual")
Channel through which the event will take place.
string
Event end date in YYYY-MM-DD format (in event timezone)
string
Event end time in 24-hour HH:MM:SS format
object
Event location information.
boolean
Whether the event is confirmed
ULID identifier of the associated gallery
string
Event start date in YYYY-MM-DD format (in event timezone)
string
Event start time in 24-hour HH:MM:SS format
string
ULID identifier of the timezone
string
Virtual meeting URL for online events
object
Representation of a phone number.
string
VSCO Workspace approved timezone name. Ignored if timezoneId is provided.
string
HTML-formatted description of the event
array
Mappings to external system entities

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_EVENT_TYPETool to create a new event type in Tave. Use when you need to define a new type of event for scheduling or tracking purposes.

Input Parameters

string
Type of event. Must be one of: call, meeting, other, session. Defaults to ‘meeting’
string
required
Name of the event type (1-24 characters)
string
Hex color code for the event type (6 characters, without # prefix)
boolean
Whether the event type is hidden
string
required
Unique prefix identifier for placeholders (1-32 characters, lowercase alphanumeric and underscores only). Must not use reserved prefixes: booked_order, brand, clients, contract, custom, customers, event, invoice, item, job, quote, order, payment, payment_schedule, primary_session, recipient, subjects, tave, team, vendors
integer
Sort position for ordering event types (0-65535). Defaults to 100
integer
Default duration in minutes (5-86400). Defaults to 60
array
List of default attendee identifiers (1-32 characters each, lowercase alphanumeric and underscores only)
array
External system mappings for this event type
string
ULID of the default location for this event type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_FILETool to create a file in Tave. Use when you need to upload a new file with binary data or link to a remote file. The file can be attached to entities and include metadata. For image files, you can specify dimensions, crop settings, and GPS coordinates.

Input Parameters

string
Display name for the file (if different from filename)
boolean
Whether the file should be hidden
string
ULID identifier of the file type
string
required
Name of the file to create (required)
string
MIME type of the file (e.g., ‘text/plain’, ‘application/pdf’, ‘image/png’)
string
URL to a remote file location instead of providing binaryData
array
List of entities this file is attached to
string
Base64-encoded binary data of the file. Maximum size is 20MB.
string
Description of the file
object
Metadata for image files
array
List of external system mappings for this file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_JOBTool to create a new job in Tave (VSCO Workspace). Use when creating leads or jobs for tracking client projects and workflows.

Input Parameters

string
Name of the job that will override the auto-generated title
string ("lead" | "booked" | "fulfillment" | "completed")
required
Stage that the job is in (lead, booked, fulfillment, or completed)
boolean
Whether the lead or job is closed
boolean
Whether the job is favorited/pinned
boolean
Whether the lead or job is a sample job
string
ULID identifier of the brand
boolean
Whether the lead or job came from a contact form
string
Event date in YYYY-MM-DD format (in studio timezone)
string
ULID identifier of the job type
string
Notes about the lead
string
Date when the job was closed in YYYY-MM-DD format (in studio timezone)
integer
Number of guests for the event
integer
Rating for the lead (1-5)
string
ULID identifier of the workflow
string
Booking date in YYYY-MM-DD format (in studio timezone)
string
Inquiry date in YYYY-MM-DD format (in studio timezone)
array
List of custom field values for the job
string
Custom job number or identifier
string
ULID identifier of the lead source
string
ULID identifier of the lead status
string
Completion date in YYYY-MM-DD format (in studio timezone)
string
ULID identifier of the contact form
integer
Maximum budget for the lead in the studio’s currency
string
ULID identifier of the closed reason
string ("low" | "medium" | "high")
Confidence level for a lead.
string
Fulfillment date in YYYY-MM-DD format (in studio timezone)
array
List of external system mappings
string
Expected decision date for the lead in YYYY-MM-DD format (in studio timezone)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_JOB_CLOSED_REASONTool to create a job closed reason in Tave. Use when you need to add a new reason for why jobs are closed. Job closed reasons help track why opportunities didn’t convert into bookings.

Input Parameters

string
required
Name of the job closed reason (required, 1-32 characters)
boolean
Whether the job closed reason is hidden
string
Description of the job closed reason (max 64 characters)
array
List of external system mappings for this job closed reason
boolean
Whether this reason should be included in reporting

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_JOB_CONTACTTool to create a job contact in Tave. Use when you need to associate a contact with a job.

Input Parameters

string
required
A lowercase ULID entity identifier for the job
boolean
Whether the contact is marked as a client. Defaults to false.
boolean
Whether or not the object is hidden
array
List of ULID entity identifiers for job roles assigned to this contact
string
required
A lowercase ULID entity identifier for the contact
array
List of role kinds (client, customer, team, subject, vendor) for the contact
array
Mappings to external system entities. These objects cannot be updated currently.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_JOB_ORDERTool to create an order on a job in Tave (VSCO Workspace). Use when creating orders for jobs to track sales, invoices, and payments.

Input Parameters

string
Custom name for the order
string
required
ULID identifier of the job to create the order on
string
Name or auto-generated title of the order
boolean
Whether the order is hidden
string ("draft" | "open" | "paid-in-full" | "completed" | "voided")
Status of the order.
string
Due date for the order in YYYY-MM-DD format
string
Date when the order was booked in YYYY-MM-DD format
array
List of line items for the order
string
ULID identifier of the tax group for calculating taxes
string
ULID identifier of the recipient from the address book
string
Custom order number or identifier
string
ULID identifier of the payment terms
object
Discount applied to an order.
boolean
Whether the order was booked from a quote
object
Discount applied to an order.
boolean
Whether the order was booked electronically

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_JOB_ROLETool to create a job role in Tave (VSCO Workspace). Use when defining roles for clients, subjects, team members, or vendors in workflows.

Input Parameters

string ("customer" | "subject" | "team" | "vendor")
Kind of job role entity.
string
required
Name of the job role (1-24 characters)
boolean
Whether the job role is hidden
string
required
Unique prefix identifier for placeholders (1-32 lowercase alphanumeric characters or underscores). Reserved prefixes that cannot be used: booked_order, brand, clients, contract, custom, customers, event, invoice, item, job, quote, order, payment, payment_schedule, primary_session, recipient, subjects, tave, team, vendors
integer
Sort position for ordering job roles (0-65535). Defaults to 100 if not specified.
array
List of external system mappings (cannot be updated after creation)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_JOB_TYPETool to create a new job type in Tave. Use when defining a new category of jobs for organizing different types of client projects.

Input Parameters

string
required
The name of this job type
boolean
Whether or not the job type is hidden
string
ULID identifier of the workflow for this job type
integer
Sort position for ordering job types (0-65535). Defaults to 100
array
List of default event types to associate with this job type
string
ULID identifier of the profit center for this job type
array
List of default job roles to associate with this job type
array
List of external system mappings for this job type
string
ULID identifier of the initial lead status for this job type
boolean
Whether a primary session is required for jobs of this type. Defaults to true

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_JOB_WORKSHEETTool to create a job using a worksheet in Tave (VSCO Workspace). Use when creating jobs with pre-populated contacts and events.

Input Parameters

string
required
Name of the job that will override the auto-generated title
string
required
Title for the job
boolean
Whether the lead or job is closed
array
List of events associated with this job
boolean
Whether the job is favorited/pinned
boolean
Whether the lead or job is a sample job
string
ULID identifier of the brand
boolean
Whether the lead or job came from a contact form
array
List of contacts associated with this job
string
Event date in YYYY-MM-DD format (in studio timezone)
string
ULID identifier of the job type
string
Notes about the lead
string
Date when the job was closed in YYYY-MM-DD format (in studio timezone)
integer
Number of guests for the event
integer
Rating for the lead (1-5)
string
ULID identifier of the workflow
string
Booking date in YYYY-MM-DD format (in studio timezone)
string
Inquiry date in YYYY-MM-DD format (in studio timezone)
array
List of custom field values for the job
string
Custom job number or identifier
string
ULID identifier of the lead source
string
ULID identifier of the lead status
string
Completion date in YYYY-MM-DD format (in studio timezone)
string
ULID identifier of the contact form
integer
Maximum budget for the lead in the studio’s currency
string
ULID identifier of the closed reason
string ("low" | "medium" | "high")
Confidence level for a lead.
string
Fulfillment date in YYYY-MM-DD format (in studio timezone)
array
List of external system mappings
string
Expected decision date for the lead in YYYY-MM-DD format (in studio timezone)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_LEAD_SOURCETool to create a lead source in Tave. Use when you need to track where leads originate from, such as social media, referrals, or websites.

Input Parameters

string
required
The name of the lead source. Must be between 3 and 128 characters.
boolean
Whether or not the lead source is hidden. Defaults to false.
string
A ULID entity identifier for the parent lead source, if this is a nested/child lead source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_LEAD_STATUSTool to create a lead status in Tave. Use when you need to define a new status for tracking leads in the sales pipeline.

Input Parameters

string ("general" | "new" | "stale")
Kind of lead status.
string
required
The name of the lead status. Must be between 1 and 64 characters.
string
Hex color code (6 characters) for the lead status display, without the # prefix.
boolean
Whether or not the lead status is hidden. Defaults to false.
integer
Sort position for ordering lead statuses. Defaults to 100.
string
A ULID entity identifier for the lead status to transition to after a specified interval.
array
List of external system mappings for this lead status.
integer
The interval duration before transitioning to another status.
string ("day" | "week" | "month" | "year")
Unit for transition interval.
string
A ULID entity identifier for the closed reason when transitioning.
string
A ULID entity identifier for the lead status to transition to after a form is sent.
string
A ULID entity identifier for the lead status to transition to after an email is sent.
string
A ULID entity identifier for the lead status to transition to after a quote is sent.
string
A ULID entity identifier for the lead status to transition to after a document is sent.
string
A ULID entity identifier for the lead status to transition to after an event is scheduled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_NOTETool to create a note in Tave (VSCO Workspace). Use when adding notes about jobs, contacts, or other entities in the system.

Input Parameters

string
Date of the note in YYYY-MM-DD format (in studio timezone)
string
ULID identifier of the job to attach the note to
boolean
Whether the note is hidden from view
string
ULID identifier of the author of the note
string
ULID identifier of the contact to attach the note to
string
required
HTML content of the note. This is the main body of the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_PAYMENTTool to create a payment in Tave. Use when recording a payment received for a job.

Input Parameters

string
Optional memo or note about the payment
string
required
A lowercase ULID entity identifier for the job this payment is associated with
integer
required
Positive numeric representing the payment amount in the studio’s currency (in cents/minor units)
boolean
Whether the payment is hidden
string ("future" | "confirmed-future" | "posted" | "failed" | "pending")
Status of the payment.
string
A lowercase ULID entity identifier for the payer
string
Authorization code for the payment transaction
string
Date when payment was received in YYYY-MM-DD format (in timezone of event or studio)
string
Check number if payment was made by check
string
A lowercase ULID entity identifier for the invoice item
string
Transaction ID from payment processor
string
A lowercase ULID entity identifier for the payment method
array
List of payment allocations to specific orders
boolean
Whether the payment was processed via client access

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_PRODUCTTool to create a product in Tave. Use when you need to add a new product with name and price.

Input Parameters

string
Stock Keeping Unit (SKU) for the product.
string
required
The name of the product.
integer
required
Positive numeric representing the product price in the studio’s currency.
boolean
Whether or not the product is hidden.
boolean
Whether the product is taxable.
array
Array of product expenses.
string
A ULID entity identifier for the vendor. Can be null.
boolean
Whether the product is deliverable.
boolean
Whether the product allows manual entry.
string ("JobDate" | "Booking" | "Never")
When the expense is due from.
string
HTML description of the product.
number
Number of periods until expense is due (max 5 digits).
string
A ULID entity identifier for the expense category. Can be null.
string ("Days" | "Weeks" | "Months")
Period type for expense due date calculation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_PRODUCT_TYPETool to create a product type in Tave. Use when defining a new category of products or services for organizing offerings in your business.

Input Parameters

string ("Session" | "Album" | "Print" | "Other" | "Service")
Kind of product type.
string
required
The name of the product type. Required field.
boolean
Whether or not the product type is hidden. Defaults to false.
string
A ULID entity identifier for the parent product type, if this is a sub-category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_PROFIT_CENTERTool to create a profit center in Tave. Use when you need to organize revenue streams or business units for financial tracking and reporting.

Input Parameters

string
required
The name of the profit center. Must be between 1 and 24 characters.
boolean
Whether or not the profit center is hidden. Defaults to false.
array
List of external system mappings for this profit center. These objects cannot be updated currently.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_REST_HOOKTool to create a RestHook webhook subscription in Tave. Use when setting up webhook notifications for events like contact creation, job creation, order booking, or payment creation.

Input Parameters

string
required
Webhook callback URL that will receive POST requests when the event occurs
string ("contact.created" | "job.created" | "order.booked" | "payment.created")
required
Type of event that will trigger this webhook (contact.created, job.created, order.booked, or payment.created)
object
Optional filters to limit which events trigger the webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_RESOURCE_TAX_RATETool to create a tax rate in Tave. Use when you need to add a new tax rate with a name and rate percentage.

Input Parameters

string
The name of the tax rate.
number
required
The floating point number representing the tax rate percentage. Has 4 points of decimal precision. For example, 8.5 represents 8.5% tax rate.
boolean
Whether or not the tax rate is hidden from display.
boolean
Whether the tax is inclusive (included in the price) or exclusive (added to the price). Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_CREATE_USERTool to create a new user in Tave. Use when you need to add a new user account associated with an existing contact from the address book.

Input Parameters

boolean
Whether the user is hidden from certain views.
boolean
Whether the user has admin privileges. Defaults to false.
string
required
Email address to be used as the username. Must be between 5 and 64 characters and follow email format.
string
required
ULID identifier of the contact to associate with this user. The contact must exist in the address book.
boolean
Whether the user has beta feature access. Defaults to false.
boolean
Whether the user is a billing contact. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_ADDRESS_BOOK_ENTRYTool to delete an entry in the address book. Use when you need to permanently remove an address book entry by its ULID. This operation cannot be undone.

Input Parameters

string
required
ULID of the address book entry to delete. Permanently removes the entry from the address book.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_BRANDTool to delete a brand by its ULID. Use when you need to permanently remove a brand from the system. The API returns a 204 No Content status on successful deletion.

Input Parameters

string
required
ULID of the brand to delete. This is the unique identifier that was returned when the brand was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_CUSTOM_FIELDTool to delete a custom field by its ULID identifier. Use when you need to remove a custom field permanently.

Input Parameters

string
required
ULID identifier of the custom field to delete. Example: 01khbe6hhn2j76hrffy0mxmq6h

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_EVENT_TYPETool to delete an event type by its ULID identifier. Use when you need to permanently remove an event type from the system.

Input Parameters

string
required
ULID identifier of the event type to delete. Example: ‘01h35ccwymj5ctckp8px1azhg6’. This action permanently removes the event type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_DISCOUNTDelete a specific discount by its ULID to permanently remove it from the system. The tool reports success for accepted 200 or 204 responses.

Input Parameters

string
required
ULID of the discount to delete. This is the unique identifier that was returned when the discount was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_DISCOUNT_TYPETool to delete a specific discount type by its ULID. Use when you need to remove a discount type from the system.

Input Parameters

string
required
ULID of the discount type to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_EVENTTool to delete an event by its ULID identifier. Use when you need to permanently remove an event from the system. This operation cannot be undone.

Input Parameters

string
required
ULID identifier of the event to delete. This action permanently removes the event from the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_JOBTool to delete a job by its ULID identifier. Use when you need to permanently remove a job from the system.

Input Parameters

string
required
ULID identifier of the job to delete. Example: ‘01khbe89198bmv8z0615c2rzv2’. This action permanently removes the job from the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_JOB_CLOSED_REASONTool to delete a job closed reason by its ULID identifier. Use when you need to permanently remove a job closed reason from the system.

Input Parameters

string
required
ULID identifier of the job closed reason to delete. Example: ‘01khbe88gp5yycxgndb848nej0’. This action permanently removes the job closed reason.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_JOB_CONTACTTool to delete a job contact by its ULID. Use when you need to permanently remove a job contact from the system. The API returns a 204 No Content status on successful deletion.

Input Parameters

string
required
ULID of the job contact to delete. This is the unique identifier that was returned when the job contact was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_JOB_ROLETool to delete a job role by its ULID identifier. Use when you need to permanently remove a job role from the system.

Input Parameters

string
required
ULID identifier of the job role to delete. Example: ‘01khbe9106mwgkwvknfme3mgjw’. This action permanently removes the job role from the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_JOB_TYPETool to delete a job type by its ULID. Use when you need to permanently remove a job type from the system. The API returns a 204 No Content status on successful deletion.

Input Parameters

string
required
ULID of the job type to delete. This is the unique identifier that was returned when the job type was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_LEAD_SOURCETool to delete a specific lead source by its ULID. Use when you need to permanently remove a lead source from the system.

Input Parameters

string
required
ULID of the lead source to delete. This action permanently removes the lead source from the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_LEAD_STATUSTool to delete a specific lead status by its ULID. Use when you need to permanently remove a lead status from the system.

Input Parameters

string
required
ULID of the lead status to delete. This action permanently removes the lead status from the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_NOTETool to delete a note by its ULID identifier. Use when you need to remove a note from the system. Note that this performs a soft delete by setting the ‘hidden’ field to true.

Input Parameters

string
required
ULID identifier of the note to delete. This action performs a soft delete by setting the ‘hidden’ field to true rather than permanently removing the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_PAYMENTSTool to delete a specific payment by its ULID. Use when you need to permanently remove a payment from the system. The API returns a 204 No Content status on successful deletion.

Input Parameters

string
required
ULID of the payment to delete. This is the unique identifier that was returned when the payment was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_PRODUCTTool to delete a specific product by its ULID. Use when you need to permanently remove a product from the system. The API returns a 204 No Content status on successful deletion.

Input Parameters

string
required
ULID of the product to delete. This is the unique identifier that was returned when the product was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_PRODUCT_TYPETool to delete a specific product type by its ULID. Use when you need to permanently remove a product type from the system. The API returns a 204 No Content status on successful deletion.

Input Parameters

string
required
ULID of the product type to delete. This is the unique identifier that was returned when the product type was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_PROFIT_CENTERTool to delete a profit center by its ULID. Use when you need to permanently remove a profit center from the system. The API returns a 204 No Content status on successful deletion.

Input Parameters

string
required
ULID of the profit center to delete. This is the unique identifier that was returned when the profit center was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_REST_HOOKTool to unsubscribe from and delete a RestHook webhook subscription by its ULID. Use when you need to permanently remove a webhook registration from the system. The API returns a 204 No Content status on successful deletion.

Input Parameters

string
required
ULID of the RestHook to delete. This is the unique identifier that was returned when the RestHook was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_TAX_GROUPTool to delete a specific tax group by its ULID. Use when you need to permanently remove a tax group from the system. The API returns a 204 No Content status on successful deletion.

Input Parameters

string
required
ULID of the tax group to delete. This is the unique identifier that was returned when the tax group was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_TAX_RATETool to delete a specific tax rate by its ULID. Use when you need to permanently remove a tax rate from the system. The API returns a 204 No Content status on successful deletion.

Input Parameters

string
required
ULID of the tax rate to delete. This is the unique identifier that was returned when the tax rate was created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_DELETE_RESOURCE_USERTool to delete a user by its ULID. Use when you need to remove a user from the system. The API returns a 204 No Content status on successful deletion.

Input Parameters

string
required
ULID of the user to delete. This is the unique identifier for the user resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_BRANDTool to retrieve a specific brand from Tave by its ULID. Use when you need detailed information about a brand’s configuration, including name, contact details, theme settings, and custom domain information.

Input Parameters

string
required
ULID identifier of the brand to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_EVENTTool to get a specific event by its ID. Use when you need to retrieve detailed information about a single event.

Input Parameters

string
required
ULID to perform an action on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_EVENT_TYPETool to retrieve a specific event type by ID. Use when you need to fetch details about a specific event type including its name, color, default settings, and metadata.

Input Parameters

string
required
ULID identifier of the event type to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_ADDRESS_BOOKTool to fetch a specific Address Book entity by its ULID. Use when you need to retrieve detailed information about a person, company, or location from the address book.

Input Parameters

string
required
ULID to perform an action on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_ADDRESS_BOOK_CATool to fetch the address associated with a given location ID. Use when you need to retrieve detailed address information from the Tave address book.

Input Parameters

string
required
ULID to perform an action on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_CUSTOM_FIELDTool to fetch a specific custom field by ID from Tave. Use when you need to retrieve details about a custom field definition.

Input Parameters

string
required
ULID identifier of the custom field to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_DISCOUNTTool to retrieve a specific discount by its ID. Use when you need to get detailed information about a discount including its name, price, type, and other attributes.

Input Parameters

string
required
ULID of the discount to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_DISCOUNT_TYPETool to get a specific discount type by ID. Use when you need to retrieve details about a particular discount type resource.

Input Parameters

string
required
ULID to perform an action on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_JOBTool to fetch a specific job by ID from Tave. Use when you need to retrieve detailed information about a job including its stage, dates, financial data, and associated metadata.

Input Parameters

string
required
ULID identifier of the job to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_JOB_CLOSED_REASONTool to retrieve a specific job closed reason by its ID. Use when you need to get detailed information about a job closed reason including its name, description, and reporting settings.

Input Parameters

string
required
ULID identifier of the job closed reason to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_JOB_CONTACTTool to fetch a specific job contact by ID from Tave. Use when you need to retrieve details about a contact associated with a job.

Input Parameters

string
required
ULID identifier of the job contact to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_JOB_ROLETool to retrieve a specific job role by its ID. Use when you need to get detailed information about a job role including its name, token prefix, kind, and other properties.

Input Parameters

string
required
ULID identifier of the job role to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_JOB_TYPETool to retrieve a specific job type by ID. Use when you need detailed information about a job type including its name, default contacts, default events, and configuration settings.

Input Parameters

string
required
ULID identifier of the job type to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_JOB_WORKSHEETTool to fetch a Job Worksheet for a specific job by job ID. Use when you need detailed job information including contacts, events, financial data, and workflow details.

Input Parameters

string
required
ULID identifier of the job to retrieve the worksheet for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_LEAD_SOURCETool to retrieve a specific lead source by its ID. Use when you need to get detailed information about where a lead originated from.

Input Parameters

string
required
ULID identifier of the lead source to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_LEAD_STATUSTool to retrieve a specific lead status by its ID. Use when you need to get detailed information about a lead status including its transitions and configuration.

Input Parameters

string
required
ULID identifier of the lead status to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_MY_STUDIOTool to retrieve information about your studio from Tave. Use when you need to fetch studio configuration settings, including name, currency, date/time formats, and license plan details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_NOTETool to fetch a specific note by ID from Tave. Use when you need to retrieve detailed information about a note including its content, author, associated entities, and timestamps.

Input Parameters

string
required
ULID identifier of the note to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_ORDERTool to fetch a specific order by ID from Tave. Use when you need to retrieve detailed information about an order including line items, invoices, payment allocations, tax details, and financial totals.

Input Parameters

string
required
ULID identifier of the order to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_PAYMENTTool to fetch a specific payment by ID from Tave. Use when you need to retrieve detailed information about a payment including amount, status, allocations, and refunds.

Input Parameters

string
required
ULID identifier of the payment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_PAYMENT_METHODTool to retrieve a specific payment method by its ID. Use when you need to get detailed information about a payment method including its name, type, and status.

Input Parameters

string
required
ULID identifier of the payment method to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_PRODUCTTool to retrieve a specific product by its ID. Use when you need to get detailed information about a product including its name, price, SKU, and other attributes.

Input Parameters

string
required
ULID identifier of the product to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_PRODUCT_TYPETool to retrieve a specific product type by its ID. Use when you need to get detailed information about a product type including its name, kind, and visibility settings.

Input Parameters

string
required
ULID identifier of the product type to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_PROFIT_CENTERTool to retrieve a specific profit center by its ID. Use when you need to get detailed information about a profit center for tracking revenue and expenses.

Input Parameters

string
required
ULID identifier of the profit center to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_TAX_RATETool to retrieve a specific tax rate by its ULID. Use when you need detailed information about a tax rate including its name, rate percentage, and whether it is inclusive.

Input Parameters

string
required
ULID identifier of the tax rate to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_TIMEZONETool to retrieve a specific timezone by its ULID from Tave. Use when you need to fetch timezone details including the timezone name, display name, codes, region, and location information.

Input Parameters

string
required
ULID identifier of the timezone to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_GET_RESOURCE_USERTool to retrieve a specific user by their ULID identifier. Use when you need to get detailed information about a user including their contact ID, username, permissions, and timestamps.

Input Parameters

string
required
ULID to perform an action on. A lowercase ULID entity identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_ADDRESS_BOOKTool to list contacts in the studio’s address book. Use when you need to retrieve all contacts or filter by email with pagination support.

Input Parameters

integer
The page of results to return.
string
Filter contacts by email. When specified, results are ranked by match quality.
string
Sort items in the collection by the given property (e.g., id, name, email, modified, created).
integer
Number of results per page to return in the collection.
boolean
Include contacts that have been hidden.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_BRANDSList a page of brands configured for a studio, with pagination, hidden-brand inclusion, external mapping ID filtering, and sorting options.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include objects that have been hidden
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_DISCOUNT_TYPESTool to get a list of discount types from Tave. Use when you need to retrieve available discount types for your account.

Input Parameters

string
Sort items in the collection by the given property. Default is ‘id’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_EVENTSTool to list a studio’s events from Tave. Use when you need to retrieve events with optional filtering by job, external mapping ID, or visibility status.

Input Parameters

integer
The page of results to return.
string
Include objects attached to a job
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include objects that have been hidden
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_EVENT_TYPESList a studio’s event types, with pagination and optional visibility and external mapping filters.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include objects that have been hidden
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_FILESTool to list files in Tave. Use when you need to retrieve files associated with jobs or contacts. Supports pagination and filtering by job, contact, or external mapping ID.

Input Parameters

integer
The page of results to return.
string
Include objects attached to a job.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
string
A ULID entity identifier for filtering files by contact.
boolean
Include objects that have been hidden.
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_CUSTOM_FIELDTool to list custom fields configured on a studio. Use when you need to retrieve all custom fields or filter them by resource type (contact/job) or kind.

Input Parameters

array
Filter custom fields by their kind/type (e.g., textfield, textbox, number, money, checkbox, date, decimal, dropdown, time).
string
Sort items in the collection by the given property (e.g., id, name, created, modified).
string ("contact" | "job")
Enum for resource types that custom fields can apply to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_DISCOUNTTool to get a list of discounts from Tave. Use when you need to retrieve all available discounts.

Input Parameters

string
Sort items in the collection by the given property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_GALLERYTool to list all galleries for a studio. Use when you need to retrieve galleries with optional filtering and pagination.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include objects that have been hidden
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_JOBList a page of jobs for a studio, with optional filtering by closed status or external mapping ID and configurable pagination and sorting.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include jobs that have been closed
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_JOB_CLOSED_REASONList a page of a studio’s job closed reasons, with optional filtering and sorting.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include objects that have been hidden
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_JOB_CONTACTTool to list a job’s contacts. Use when you need to retrieve contacts associated with jobs, with optional filtering by contact ID, job ID, or external mapping ID.

Input Parameters

integer
The page of results to return.
string
Include objects attached to a job
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
string
A ULID entity identifier that is nullable.
boolean
Include objects that have been hidden
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_JOB_ORDERSTool to list orders on a given job. Use when you need to retrieve all orders associated with a specific job.

Input Parameters

string
required
A lowercase ULID entity identifier for the job
string
Sort items in the collection by the given property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_JOB_PAYMENTTool to get a list of payments for a specific job. Use when you need to retrieve payment information associated with a particular job.

Input Parameters

string
required
ULID of the job to get payments for.
string
Sort items in the collection by the given property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_JOB_ROLEList a page of a studio’s job roles, with optional filtering and sorting.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include objects that have been hidden
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_JOB_TYPEList a page of job types for a studio, with optional filtering by hidden status or external mapping ID. Use pagination to retrieve additional results.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include objects that have been hidden
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_LEAD_SOURCEList a page of a studio’s lead sources for tracking where leads originated. Use pagination to retrieve additional results.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include objects that have been hidden
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_LEAD_STATUSList a page of a studio’s lead statuses for tracking leads in the sales pipeline, with pagination and filtering options.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include objects that have been hidden
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_NOTEList notes from Tave with pagination and filtering, including a filter for notes associated with a job.

Input Parameters

integer
The page of results to return.
string
Include objects attached to a job
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include objects that have been hidden
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_ORDERTool to get a list of all orders. Use when you need to retrieve orders across all jobs with pagination support.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_PAYMENTTool to get a list of payments from Tave. Use when you need to retrieve all payments with optional pagination and sorting.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_PAYMENT_METHODTool to get a list of payment methods from Tave. Use when you need to retrieve all available payment methods.

Input Parameters

string
Sort items in the collection by the given property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_PRODUCTTool to get a list of products from Tave. Use when you need to retrieve all products with optional sorting.

Input Parameters

string
Sort items in the collection by the given property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_PRODUCT_TYPEList a page of product types in Tave, with pagination and sorting options.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_PROFIT_CENTERList a page of a studio’s profit centers, with pagination, sorting, and filtering options for tracking business segments or cost centers.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include objects that have been hidden
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_REST_HOOKTool to list REST hooks configured in Tave. Use when you need to retrieve webhook registrations that notify external services of events.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include objects that have been hidden

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_TAX_GROUPSTool to get a list of Tax Groups from Tave. Use when you need to retrieve available tax groups for tax calculations.

Input Parameters

string
Sort items in the collection by the given property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_TAX_RATESTool to get a list of tax rates from Tave. Use when you need to retrieve all available tax rates for your account.

Input Parameters

string
Sort items in the collection by the given property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_TIMEZONETool to get a list of timezones from Tave. Use when you need to retrieve available timezones for scheduling or location-based operations.

Input Parameters

integer
The page of results to return.
Search Timezone by name, code, country, etc.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_LIST_RESOURCE_USERList a page of users for the studio account, with pagination and sorting options. Hidden users can be included, and results can be filtered by external mapping ID.

Input Parameters

integer
The page of results to return.
string
Sort items in the collection by the given property.
integer
Number of results per page to return in the collection.
boolean
Include objects that have been hidden
string
Filter objects by an external id for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_ADDRESS_BOOKUpdate a specific Tave address book entry by ID, including its contact information or entry type. The tool supports a defined set of entry fields and requires the entry type.

Input Parameters

string
required
ULID of the address book entry to update
object
Phone number object
string
Website URL
string ("person" | "company" | "location")
required
Type of address book entry: person, company, or location
string
Primary email address
string
Gender
boolean
Whether the entry is hidden from default views
boolean
Whether the entry is pinned for quick access
string
Physical address
string
Associated brand ID
string
Job title
string
Last name (typically used for person kind)
string
Birth date
object
Phone number object
string
First name (typically used for person kind)
object
Phone number object
object
Phone number object
string
Maiden name
string
Salutation or title
string
Anniversary date
string
Company name (typically used for company kind)
boolean
Privacy opt-in status for communications
string
Mailing address if different from physical address
boolean
Whether this contact is a previous client
string
Secondary email address
string
Twitter username
string
Facebook username
boolean
Whether strict privacy requirements apply to this contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_BRANDTool to update a specific brand in Tave. Use when you need to modify brand settings such as name, alias, contact information, theme, or domain configuration.

Input Parameters

string
required
ULID identifier of the brand to update
string
BCC email address for brand communications
string
The brand’s name (4-128 characters)
string
Brand alias (4-32 characters)
object
Theme configuration for the brand.
boolean
Whether the brand is hidden
object
Phone number configuration for the brand.
object
Phone number configuration for the brand.
object
Phone number configuration for the brand.
string
Reply-to email address for brand communications
string
Forward-to email address for brand communications
string
Shorter name for the brand to be used in constrained UI places (4-128 characters)
string
ULID of the associated location
string
Office hours for the brand
string
Custom domain for the brand
array
External system mappings for the brand
boolean
Whether to enable profile editing
string
Google Analytics tracking ID (format: UA-XXXXXX-X, YT-XXXXXX-X, or MO-XXXXXX-X)
string
ULID of the root contact form
string ("active" | "pending" | "dns-failed" | "ssl-failed")
Status of the custom domain configuration.
integer
Client access version (1-10)
boolean
Whether to show history in the client portal
boolean
Whether to break out package pricing

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_EVENT_TYPETool to update an existing event type in Tave. Use when you need to modify event type properties like name, color, duration, or classification. Requires the event type ID and at least the required fields (name and tokenPrefix).

Input Parameters

string
required
ULID identifier of the event type to update
string ("call" | "meeting" | "other" | "session")
Event type kind options.
string
required
Name of the event type (1-24 characters)
string
Hex color code for the event type (6 characters, lowercase hex)
boolean
Whether the event type is hidden from view
string
required
Unique prefix identifier for placeholders (lowercase alphanumeric and underscores only). Cannot use reserved prefixes: booked_order, brand, clients, contract, custom, customers, event, invoice, item, job, quote, order, payment, payment_schedule, primary_session, recipient, subjects, tave, team, vendors
integer
Sort position for ordering event types (0-65535)
integer
Default duration for events of this type in minutes (5-86400)
array
List of default attendee token prefixes (lowercase alphanumeric and underscores, 1-32 chars each)
array
External system mappings for this event type
string
ULID of the default location for this event type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_CUSTOM_FIELDTool to update a specific custom field in Tave. Use when you need to modify custom field properties like name, kind, client access, or visibility.

Input Parameters

string
required
ULID identifier of the custom field to update
string ("TextField" | "TextBox" | "DropDown" | "Number" | "Decimal" | "Money" | "Date" | "Time" | "Checkbox")
Enum for the kind of custom field.
string
Name of the custom field (max 255 characters)
string
Token identifier for the custom field (max 128 characters)
boolean
Whether the custom field is hidden
array
List of choices for DropDown kind custom fields
string ("Job" | "Contact")
Enum for the type of resource the custom field can apply to.
string
Label displayed to clients (max 255 characters)
string ("None" | "Visible" | "Editable")
Enum for the client access level of the custom field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_EVENTTool to update a specific event in Tave. Use when modifying event details such as name, date/time, location, channel, or other event attributes.

Input Parameters

string
required
ULID identifier of the event to update
string
Name of the event
string
ULID identifier of the associated job
boolean
Whether the event is all-day
boolean
Whether the event is hidden from view
string
ULID identifier of the event type
string ("InPerson" | "Phone" | "Virtual")
Event channel type.
string
End date in YYYY-MM-DD format
string
End time in 24-hour format (HH:MM:SS)
object
Event location details.
boolean
Whether the event is confirmed
ULID identifier of the associated gallery
string
Start date in YYYY-MM-DD format
string
Start time in 24-hour format (HH:MM:SS)
string
ULID identifier of the timezone
string
URL for virtual events
object
Phone number representation.
string
Timezone name (ignored if timezoneId is provided)
string
HTML description of the event
array
External system mappings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_JOBTool to update a specific job in Tave (VSCO Workspace). Use when modifying existing job details like name, dates, stage, or other job properties.

Input Parameters

string
required
ULID identifier of the job to update
string
Name of the job that will override the auto-generated title
string ("lead" | "booked" | "fulfillment" | "completed")
Stage of the job in the workflow.
boolean
Whether the lead or job is closed
boolean
Whether the job is favorited/pinned
boolean
Whether the lead or job is a sample job
string
ULID identifier of the brand
boolean
Whether the lead or job came from a contact form
string
Event date in YYYY-MM-DD format (in studio timezone)
string
ULID identifier of the job type
string
Notes about the lead
string
Date when the job was closed in YYYY-MM-DD format (in studio timezone)
integer
Number of guests for the event
integer
Rating for the lead (1-5)
string
ULID identifier of the workflow
string
Booking date in YYYY-MM-DD format (in studio timezone)
string
Inquiry date in YYYY-MM-DD format (in studio timezone)
array
List of custom field values for the job
string
Custom job number or identifier
string
ULID identifier of the lead source
string
ULID identifier of the lead status
string
Completion date in YYYY-MM-DD format (in studio timezone)
string
ULID identifier of the contact form
integer
Maximum budget for the lead in the studio’s currency
string
ULID identifier of the closed reason
string ("low" | "medium" | "high")
Confidence level for a lead.
string
Fulfillment date in YYYY-MM-DD format (in studio timezone)
array
List of external system mappings
string
Expected decision date for the lead in YYYY-MM-DD format (in studio timezone)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_JOB_CLOSED_REASONTool to update a job closed reason in Tave. Use when you need to modify the name, description, visibility, or reporting settings of a job closed reason.

Input Parameters

string
required
ULID identifier of the job closed reason to update
string
required
Name of the job closed reason (1-32 characters)
boolean
Whether the job closed reason is hidden from view
string
Optional description of the job closed reason (max 64 characters)
array
External system mappings for this job closed reason
boolean
Whether this reason should be included in reporting

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_JOB_CONTACTTool to update a specific job contact in Tave. Use when modifying contact associations with jobs, changing client status, or updating job roles for a contact.

Input Parameters

string
required
ULID identifier of the job contact to update
string
required
ULID identifier of the job
boolean
Whether this contact is the primary client for the job
boolean
Whether the job contact is hidden from view
array
List of job role ULID identifiers associated with this contact
string
required
ULID identifier of the contact
array
List of role kinds for this job contact (client, customer, team, subject, vendor)
array
External system mappings for this job contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_JOB_ROLETool to update a job role in Tave. Use when you need to modify the name, token prefix, kind, visibility, or sort position of a job role.

Input Parameters

string
required
ULID identifier of the job role to update
string ("customer" | "subject" | "team" | "vendor")
Type/kind of the job role
string
required
Name of the job role (1-24 characters)
boolean
Whether the job role is hidden from view
string
required
The prefix identifier for placeholders (must be unique across all job roles). Reserved prefixes that cannot be used: booked_order, brand, clients, contract, custom, customers, event, invoice, item, job, quote, order, payment, payment_schedule, primary_session, recipient, subjects, tave, team, vendors
integer
Sort position for ordering job roles (0-65535)
array
External system mappings for this job role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_JOB_TYPETool to update an existing job type in Tave. Use when modifying properties of a job category such as name, visibility, or associated defaults.

Input Parameters

string
required
ULID identifier of the job type to update
string
required
The name of this job type
boolean
Whether or not the job type is hidden
string
ULID identifier of the workflow for this job type
integer
Sort position for ordering job types (0-65535)
array
List of default event types to associate with this job type
string
ULID identifier of the profit center for this job type
array
List of default job roles to associate with this job type
array
List of external system mappings for this job type
string
ULID identifier of the initial lead status for this job type
boolean
Whether a primary session is required for jobs of this type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_LEAD_SOURCETool to update a specific lead source in Tave. Use when you need to modify lead source properties such as name, parent relationship, or visibility.

Input Parameters

string
required
ULID identifier of the lead source to update
string
required
The name of the lead source. Must be between 3 and 128 characters. This field is required for updates.
boolean
Whether or not the lead source is hidden.
string
A ULID entity identifier for the parent lead source, if this is a nested/child lead source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_LEAD_STATUSTool to update a specific lead status in Tave. Use when you need to modify lead status properties such as name, color, sort position, or automated transition rules.

Input Parameters

string
required
ULID identifier of the lead status to update
string ("general" | "new" | "stale")
Enum for lead status kind values.
string
The name of the lead status. Must be between 1 and 64 characters.
string
Hex color code for the lead status (6 characters, lowercase hex). Example: ‘278639’ for green.
boolean
Whether or not the lead status is hidden.
integer
Sort position for ordering lead statuses. Must be between 0 and 65535.
string
ULID of the lead status to transition to automatically based on time interval.
array
List of external system mappings for this lead status.
integer
Time interval for automatic transition. Must be between 0 and 99999999999.
string ("day" | "week" | "month" | "year")
Enum for transition interval unit values.
string
ULID of the closed reason to use when transitioning to a closed status.
string
ULID of the lead status to transition to after a form is sent.
string
ULID of the lead status to transition to after an email is sent.
string
ULID of the lead status to transition to after a quote is sent.
string
ULID of the lead status to transition to after a document is sent.
string
ULID of the lead status to transition to after an event is scheduled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_NOTEUpdate a specific note in Tave, supplying its HTML content and optionally modifying properties such as its associated job, contact, or visibility.

Input Parameters

string
required
ULID identifier of the note to update
string
Date string in YYYY-MM-DD format in the timezone of the event or studio.
string
ULID identifier of the job associated with the note.
boolean
Whether or not the note is hidden.
string
ULID identifier of the author of the note.
string
ULID identifier of the contact associated with the note.
string
required
HTML content of the note. This is a required field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_ORDERTool to update a specific order in Tave (VSCO Workspace). Use when modifying existing order details like name, status, line items, or other order properties.

Input Parameters

string
required
ULID identifier of the order to update
string
Custom name for the order
string
Name or auto-generated title of the order
boolean
Whether the order is hidden
string ("draft" | "open" | "paid-in-full" | "completed" | "voided")
Status of the order.
string
Due date for the order in YYYY-MM-DD format
string
Date when the order was booked in YYYY-MM-DD format
array
List of line items for the order
string
ULID identifier of the tax group for calculating taxes
string
ULID identifier of the recipient from the address book
string
Custom order number or identifier (max 16 characters)
string
Reference code for the order (max 11 characters)
string
ULID identifier of the payment terms
object
Discount applied to an order.
boolean
Whether the order was booked from a quote
object
Discount applied to an order.
boolean
Whether taxes are compounded (tax the tax)
boolean
Whether the order was booked electronically

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_PROFIT_CENTERTool to update a specific profit center in Tave. Use when you need to modify an existing profit center’s name or visibility settings.

Input Parameters

string
required
ULID identifier of the profit center to update
string
The name of the profit center. Must be between 1 and 24 characters.
boolean
Whether or not the profit center is hidden.
array
List of external system mappings for this profit center. These objects cannot be updated currently.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_TAX_GROUPTool to update a specific tax group in Tave. Use when you need to modify tax group properties like name, compounding settings, default status, or associated tax rates.

Input Parameters

string
required
ULID identifier of the tax group to update
string
Name of the tax group (max 64 characters)
boolean
Whether the tax group is hidden
boolean
Whether this is the default tax group
array
List of tax rates associated with this tax group (max 3 items)
boolean
Whether the tax group uses compounding (taxes applied sequentially)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_TAX_RATETool to update a specific tax rate in Tave. Use when you need to modify tax rate properties such as name, rate percentage, or inclusive/exclusive status.

Input Parameters

string
required
ULID identifier of the tax rate to update
string
Name of the tax rate (max 32 characters)
number
The floating point number representing the tax rate percentage. Has 4 points of decimal precision.
boolean
Whether the tax rate is hidden from view
boolean
Whether the tax is inclusive (included in the price) or exclusive (added to the price)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_RESOURCE_USERTool to update a specific user in Tave. Use when you need to modify user properties such as contact association, beta access, admin status, or visibility.

Input Parameters

string
required
ULID identifier of the user to update
boolean
Whether or not the user is hidden.
boolean
Whether or not the user is an admin.
string
Email address used as username. Must be between 5 and 64 characters.
string
A lowercase ULID entity identifier for the contact associated with this user.
boolean
Whether or not the user has beta access.
boolean
Whether or not the user is a billing contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVE_UPDATE_STUDIO_READONLY_MODETool to set studio readonly mode in Tave. Use when you need to enable or disable readonly mode for the authenticated studio.

Input Parameters

boolean
required
Whether to enable or disable readonly mode for the studio. When enabled, the studio will be in readonly mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not