Tave is the best Studio Management Application for Photographers, providing tools for client management, job tracking, and business operations.
Tave is the best Studio Management Application for Photographers, providing tools for client management, job tracking, and business operations. On Nagent, Tave is exposed as a fully-configurable crm integration that any agent can call — 129 actions, and API key authentication. No code is required to wire Tave into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Tave to automate the kinds of tasks crm teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Tave into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Every operation an agent can call against Tave, with input parameters and output schema. Drop these into any step of an agent built in Helix.
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
ULID of the payment to apply. This is the unique identifier of the payment that will be applied to the order.
Positive numeric representing an amount in the studio's currency. The amount of the payment to apply to the order.
ULID of the order to apply the payment to. This is the unique identifier of the order that will receive the payment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
BCC email address for all outgoing emails from this brand.
The brand's name. Must be between 4 and 128 characters.
Unique alias for the brand URL. Must be between 4 and 32 characters.
Brand theme configuration.
Brand phone number with label.
Brand phone number with label.
Brand phone number with label.
Reply-to email address for emails sent from this brand.
Email address to forward incoming messages to.
A shorter name for the brand to be used in constrained UI places.
ULID identifier of the location associated with this brand.
Office hours information text.
Custom domain for the brand's client portal.
List of external system mappings for this brand.
Whether clients can edit their profile information.
Google Analytics tracking ID. Must match pattern (UA\\|YT\\|MO)-\\d+-\\d+
ULID identifier of the root contact form for this brand.
Client access version number. Must be between 1 and 10.
Whether to show interaction history in the client portal.
Whether to break out package pricing in client-facing views.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The type of input field (TextField, TextBox, DropDown, Number, Decimal, Money, Date, Time, Checkbox)
The name of the custom field
A unique token identifier for this custom field
Whether this custom field should be hidden from view
List of choices for DropDown field type. Required when kind is DropDown
The resource type this field can be applied to (Job or Contact)
The label to display to clients when they have access to this field
Client access level for this field (None, Visible, Editable)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The name of the discount type (required)
Whether or not the discount type is hidden. Defaults to false if not provided.
A ULID entity identifier for the parent discount type, if any. Set to null for root-level discount types.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_CREATE_GALLERYTool to create a new gallery in Tave (VSCO Workspace). Use when you need to create a gallery with a name, client URL, and admin URL. Note that remoteId and remoteCreated are also required.
Input parameters
The name of this gallery.
The URL path slug for this gallery. Must contain only letters, numbers, dashes, and underscores. Will be converted to lowercase.
A ULID entity identifier for the job this gallery is associated with.
Whether this gallery is hidden.
Whether this gallery is publicly accessible.
A ULID entity identifier for the event this gallery is associated with.
The internal URL of this gallery in the remote admin portal. May be used to link employees to the gallery administration interface in the remote service.
The category of this gallery. Galleries may be grouped by this category text in future client portal designs.
The headline of this gallery. Prioritized over name when displayed to the user.
A reusable plain-text passcode for unlocking the gallery. This pass code may be given to invited users.
The remote ID of this gallery. This value must be unique for the studio.
The URL of this gallery. Will be used for links in emails and the client portal.
The date of the event this gallery is for in YYYY-MM-DD format. Useful in automations or email tokens.
Cover photo details for a gallery.
The date this gallery will be released to the public in YYYY-MM-DD format. Useful in automations or email tokens.
The date that orders for this gallery are due by in YYYY-MM-DD format. Useful in automations or email tokens.
The creation date and time of this gallery in UTC (ISO 8601 format).
The date this gallery will expire and no longer be accessible in YYYY-MM-DD format. Useful in automations or email tokens.
External mappings to relate this gallery to entities in external systems.
Whether this gallery requires a password for access. Defaults to true.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Type of address book entry. Valid values: 'person', 'company', 'location'
Email address of the contact
Last name of the person (for kind='person')
First name of the person (for kind='person')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Stock Keeping Unit (SKU) for the discount.
Enum for discount kind values.
The name of the discount.
Positive numeric representing an amount in the studio's currency. For percentage discounts, this represents the percentage value (e.g., 10 for 10%).
Whether or not the discount is hidden.
Whether the discount is a rebate. Defaults to false.
A lowercase ULID entity identifier for the discount type.
Whether the discount allows manual entry. Defaults to true.
HTML description of the discount.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_CREATE_RESOURCE_EVENTTool to create a new event in Tave (VSCO Workspace). Use when scheduling meetings, sessions, or appointments.
Input parameters
Name or title of the event
ULID identifier of the associated job
Whether this is an all-day event
Whether the event is hidden
ULID identifier of the event type
Channel through which the event will take place.
Event end date in YYYY-MM-DD format (in event timezone)
Event end time in 24-hour HH:MM:SS format
Event location information.
Whether the event is confirmed
ULID identifier of the associated gallery
Event start date in YYYY-MM-DD format (in event timezone)
Event start time in 24-hour HH:MM:SS format
ULID identifier of the timezone
Virtual meeting URL for online events
Representation of a phone number.
VSCO Workspace approved timezone name. Ignored if timezoneId is provided.
HTML-formatted description of the event
Mappings to external system entities
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Type of event. Must be one of: call, meeting, other, session. Defaults to 'meeting'
Name of the event type (1-24 characters)
Hex color code for the event type (6 characters, without # prefix)
Whether the event type is hidden
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
Sort position for ordering event types (0-65535). Defaults to 100
Default duration in minutes (5-86400). Defaults to 60
List of default attendee identifiers (1-32 characters each, lowercase alphanumeric and underscores only)
External system mappings for this event type
ULID of the default location for this event type
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Display name for the file (if different from filename)
Whether the file should be hidden
ULID identifier of the file type
Name of the file to create (required)
MIME type of the file (e.g., 'text/plain', 'application/pdf', 'image/png')
URL to a remote file location instead of providing binaryData
List of entities this file is attached to
Base64-encoded binary data of the file. Maximum size is 20MB.
Description of the file
Metadata for image files
List of external system mappings for this file
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Name of the job that will override the auto-generated title
Stage that the job is in (lead, booked, fulfillment, or completed)
Whether the lead or job is closed
Whether the job is favorited/pinned
Whether the lead or job is a sample job
ULID identifier of the brand
Whether the lead or job came from a contact form
Event date in YYYY-MM-DD format (in studio timezone)
ULID identifier of the job type
Notes about the lead
Date when the job was closed in YYYY-MM-DD format (in studio timezone)
Number of guests for the event
Rating for the lead (1-5)
ULID identifier of the workflow
Booking date in YYYY-MM-DD format (in studio timezone)
Inquiry date in YYYY-MM-DD format (in studio timezone)
List of custom field values for the job
Custom job number or identifier
ULID identifier of the lead source
ULID identifier of the lead status
Completion date in YYYY-MM-DD format (in studio timezone)
ULID identifier of the contact form
Maximum budget for the lead in the studio's currency
ULID identifier of the closed reason
Confidence level for a lead.
Fulfillment date in YYYY-MM-DD format (in studio timezone)
List of external system mappings
Expected decision date for the lead in YYYY-MM-DD format (in studio timezone)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Name of the job closed reason (required, 1-32 characters)
Whether the job closed reason is hidden
Description of the job closed reason (max 64 characters)
List of external system mappings for this job closed reason
Whether this reason should be included in reporting
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
A lowercase ULID entity identifier for the job
Whether the contact is marked as a client. Defaults to false.
Whether or not the object is hidden
List of ULID entity identifiers for job roles assigned to this contact
A lowercase ULID entity identifier for the contact
List of role kinds (client, customer, team, subject, vendor) for the contact
Mappings to external system entities. These objects cannot be updated currently.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Custom name for the order
ULID identifier of the job to create the order on
Name or auto-generated title of the order
Whether the order is hidden
Status of the order.
Due date for the order in YYYY-MM-DD format
Date when the order was booked in YYYY-MM-DD format
List of line items for the order
ULID identifier of the tax group for calculating taxes
ULID identifier of the recipient from the address book
Custom order number or identifier
ULID identifier of the payment terms
Discount applied to an order.
Whether the order was booked from a quote
Discount applied to an order.
Whether the order was booked electronically
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Kind of job role entity.
Name of the job role (1-24 characters)
Whether the job role is hidden
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
Sort position for ordering job roles (0-65535). Defaults to 100 if not specified.
List of external system mappings (cannot be updated after creation)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The name of this job type
Whether or not the job type is hidden
ULID identifier of the workflow for this job type
Sort position for ordering job types (0-65535). Defaults to 100
List of default event types to associate with this job type
ULID identifier of the profit center for this job type
List of default job roles to associate with this job type
List of external system mappings for this job type
ULID identifier of the initial lead status for this job type
Whether a primary session is required for jobs of this type. Defaults to true
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Name of the job that will override the auto-generated title
Title for the job
Whether the lead or job is closed
List of events associated with this job
Whether the job is favorited/pinned
Whether the lead or job is a sample job
ULID identifier of the brand
Whether the lead or job came from a contact form
List of contacts associated with this job
Event date in YYYY-MM-DD format (in studio timezone)
ULID identifier of the job type
Notes about the lead
Date when the job was closed in YYYY-MM-DD format (in studio timezone)
Number of guests for the event
Rating for the lead (1-5)
ULID identifier of the workflow
Booking date in YYYY-MM-DD format (in studio timezone)
Inquiry date in YYYY-MM-DD format (in studio timezone)
List of custom field values for the job
Custom job number or identifier
ULID identifier of the lead source
ULID identifier of the lead status
Completion date in YYYY-MM-DD format (in studio timezone)
ULID identifier of the contact form
Maximum budget for the lead in the studio's currency
ULID identifier of the closed reason
Confidence level for a lead.
Fulfillment date in YYYY-MM-DD format (in studio timezone)
List of external system mappings
Expected decision date for the lead in YYYY-MM-DD format (in studio timezone)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The name of the lead source. Must be between 3 and 128 characters.
Whether or not the lead source is hidden. Defaults to false.
A ULID entity identifier for the parent lead source, if this is a nested/child lead source.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Kind of lead status.
The name of the lead status. Must be between 1 and 64 characters.
Hex color code (6 characters) for the lead status display, without the # prefix.
Whether or not the lead status is hidden. Defaults to false.
Sort position for ordering lead statuses. Defaults to 100.
A ULID entity identifier for the lead status to transition to after a specified interval.
List of external system mappings for this lead status.
The interval duration before transitioning to another status.
Unit for transition interval.
A ULID entity identifier for the closed reason when transitioning.
A ULID entity identifier for the lead status to transition to after a form is sent.
A ULID entity identifier for the lead status to transition to after an email is sent.
A ULID entity identifier for the lead status to transition to after a quote is sent.
A ULID entity identifier for the lead status to transition to after a document is sent.
A ULID entity identifier for the lead status to transition to after an event is scheduled.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Date of the note in YYYY-MM-DD format (in studio timezone)
ULID identifier of the job to attach the note to
Whether the note is hidden from view
ULID identifier of the author of the note
ULID identifier of the contact to attach the note to
HTML content of the note. This is the main body of the note.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_CREATE_RESOURCE_PAYMENTTool to create a payment in Tave. Use when recording a payment received for a job.
Input parameters
Optional memo or note about the payment
A lowercase ULID entity identifier for the job this payment is associated with
Positive numeric representing the payment amount in the studio's currency (in cents/minor units)
Whether the payment is hidden
Status of the payment.
A lowercase ULID entity identifier for the payer
Authorization code for the payment transaction
Date when payment was received in YYYY-MM-DD format (in timezone of event or studio)
Check number if payment was made by check
A lowercase ULID entity identifier for the invoice item
Transaction ID from payment processor
A lowercase ULID entity identifier for the payment method
List of payment allocations to specific orders
Whether the payment was processed via client access
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Stock Keeping Unit (SKU) for the product.
The name of the product.
Positive numeric representing the product price in the studio's currency.
Whether or not the product is hidden.
Whether the product is taxable.
Array of product expenses.
A ULID entity identifier for the vendor. Can be null.
Whether the product is deliverable.
Whether the product allows manual entry.
When the expense is due from.
HTML description of the product.
Number of periods until expense is due (max 5 digits).
A ULID entity identifier for the expense category. Can be null.
Period type for expense due date calculation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Kind of product type.
The name of the product type. Required field.
Whether or not the product type is hidden. Defaults to false.
A ULID entity identifier for the parent product type, if this is a sub-category.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The name of the profit center. Must be between 1 and 24 characters.
Whether or not the profit center is hidden. Defaults to false.
List of external system mappings for this profit center. These objects cannot be updated currently.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Webhook callback URL that will receive POST requests when the event occurs
Type of event that will trigger this webhook (contact.created, job.created, order.booked, or payment.created)
Optional filters to limit which events trigger the webhook.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The name of the tax rate.
The floating point number representing the tax rate percentage. Has 4 points of decimal precision. For example, 8.5 represents 8.5% tax rate.
Whether or not the tax rate is hidden from display.
Whether the tax is inclusive (included in the price) or exclusive (added to the price). Defaults to false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Whether the user is hidden from certain views.
Whether the user has admin privileges. Defaults to false.
Email address to be used as the username. Must be between 5 and 64 characters and follow email format.
ULID identifier of the contact to associate with this user. The contact must exist in the address book.
Whether the user has beta feature access. Defaults to false.
Whether the user is a billing contact. Defaults to false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the address book entry to delete. Permanently removes the entry from the address book.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the brand to delete. This is the unique identifier that was returned when the brand was created or listed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the custom field to delete. Example: 01khbe6hhn2j76hrffy0mxmq6h
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the event type to delete. Example: '01h35ccwymj5ctckp8px1azhg6'. This action permanently removes the event type.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_DELETE_GALLERYTool to permanently delete a gallery by its ULID. Use when you need to remove a gallery. Returns 204 No Content on success.
Input parameters
ULID of the gallery to delete. WARNING: This permanently deletes the gallery. This action cannot be undone.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_DELETE_RESOURCE_DISCOUNTTool to delete a specific discount by its ULID. Use when you need to permanently remove a discount from the system. The API returns a 204 No Content status on successful deletion.
Input parameters
ULID of the discount to delete. This is the unique identifier that was returned when the discount was created or listed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the discount type to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the event to delete. This action permanently removes the event from the system.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job to delete. Example: '01khbe89198bmv8z0615c2rzv2'. This action permanently removes the job from the system.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job closed reason to delete. Example: '01khbe88gp5yycxgndb848nej0'. This action permanently removes the job closed reason.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the job contact to delete. This is the unique identifier that was returned when the job contact was created or listed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job role to delete. Example: '01khbe9106mwgkwvknfme3mgjw'. This action permanently removes the job role from the system.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the job type to delete. This is the unique identifier that was returned when the job type was created or listed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the lead source to delete. This action permanently removes the lead source from the system.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the lead status to delete. This action permanently removes the lead status from the system.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the payment to delete. This is the unique identifier that was returned when the payment was created or listed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the product to delete. This is the unique identifier that was returned when the product was created or listed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the product type to delete. This is the unique identifier that was returned when the product type was created or listed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the profit center to delete. This is the unique identifier that was returned when the profit center was created or listed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the RestHook to delete. This is the unique identifier that was returned when the RestHook was created or listed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the tax group to delete. This is the unique identifier that was returned when the tax group was created or listed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the tax rate to delete. This is the unique identifier that was returned when the tax rate was created or listed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the user to delete. This is the unique identifier for the user resource.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the brand to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID to perform an action on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the event type to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_GET_GALLERYTool to retrieve a specific gallery by ID from Tave/VSCO Workspace. Use when you need to fetch details about a gallery including its photos, status, and metadata.
Input parameters
ULID to perform an action on. The unique identifier of the gallery to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID to perform an action on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID to perform an action on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the custom field to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the discount to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID to perform an action on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job closed reason to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job contact to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job role to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job type to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job to retrieve the worksheet for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the lead source to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the lead status to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the note to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the order to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the payment to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the payment method to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the product to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the product type to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the profit center to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the tax rate to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the timezone to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID to perform an action on. A lowercase ULID entity identifier.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page of results to return.
Filter contacts by email. When specified, results are ranked by match quality.
Sort items in the collection by the given property (e.g., id, name, email, modified, created).
Number of results per page to return in the collection.
Include contacts that have been hidden.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_LIST_BRANDSTool to list brands of a studio. Use when you need to retrieve all brands configured for the studio account.
Input parameters
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include objects that have been hidden
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Sort items in the collection by the given property. Default is 'id'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page of results to return.
Include objects attached to a job
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include objects that have been hidden
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_LIST_EVENT_TYPESTool to list a studio's event types. Use when you need to retrieve all available event types for a studio.
Input parameters
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include objects that have been hidden
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page of results to return.
Include objects attached to a job.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
A ULID entity identifier for filtering files by contact.
Include objects that have been hidden.
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Filter custom fields by their kind/type (e.g., textfield, textbox, number, money, checkbox, date, decimal, dropdown, time).
Sort items in the collection by the given property (e.g., id, name, created, modified).
Enum for resource types that custom fields can apply to.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_LIST_RESOURCE_DISCOUNTTool to get a list of discounts from Tave. Use when you need to retrieve all available discounts.
Input parameters
Sort items in the collection by the given property.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include objects that have been hidden
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_LIST_RESOURCE_JOBTool to list jobs of a studio. Use when you need to retrieve all jobs for the studio account, with optional filtering by closed status or external mapping ID.
Input parameters
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include jobs that have been closed
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_LIST_RESOURCE_JOB_CLOSED_REASONTool to list a studio's job closed reasons. Use when you need to retrieve all job closed reasons configured for the studio account.
Input parameters
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include objects that have been hidden
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page of results to return.
Include objects attached to a job
Sort items in the collection by the given property.
Number of results per page to return in the collection.
A ULID entity identifier that is nullable.
Include objects that have been hidden
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
A lowercase ULID entity identifier for the job
Sort items in the collection by the given property.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID of the job to get payments for.
Sort items in the collection by the given property.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_LIST_RESOURCE_JOB_ROLETool to list a studio's job roles. Use when you need to retrieve all job roles configured for the studio account.
Input parameters
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include objects that have been hidden
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_LIST_RESOURCE_JOB_TYPETool to list job types of a studio. Use when you need to retrieve all available job types for the studio account, with optional filtering by hidden status or external mapping ID.
Input parameters
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include objects that have been hidden
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_LIST_RESOURCE_LEAD_SOURCETool to list lead sources of a studio. Use when you need to retrieve all lead sources for tracking where leads originated from.
Input parameters
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include objects that have been hidden
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_LIST_RESOURCE_LEAD_STATUSTool to list lead statuses of a studio. Use when you need to retrieve all lead statuses for tracking the state of leads in the sales pipeline.
Input parameters
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include objects that have been hidden
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_LIST_RESOURCE_NOTETool to list notes from Tave. Use when you need to retrieve notes associated with jobs or contacts, with support for pagination and filtering.
Input parameters
The page of results to return.
Include objects attached to a job
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include objects that have been hidden
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Sort items in the collection by the given property.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Sort items in the collection by the given property.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_LIST_RESOURCE_PRODUCT_TYPETool to get a list of product types from Tave. Use when you need to retrieve all available product types.
Input parameters
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_LIST_RESOURCE_PROFIT_CENTERTool to list profit centers of a studio. Use when you need to retrieve all available profit centers for tracking business segments or cost centers.
Input parameters
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include objects that have been hidden
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include objects that have been hidden
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Sort items in the collection by the given property.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Sort items in the collection by the given property.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The page of results to return.
Search Timezone by name, code, country, etc.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_LIST_RESOURCE_USERTool to list users of a studio. Use when you need to retrieve all users for the studio account with optional pagination and sorting.
Input parameters
The page of results to return.
Sort items in the collection by the given property.
Number of results per page to return in the collection.
Include objects that have been hidden
Filter objects by an external id for this provider.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_UPDATE_ADDRESS_BOOKTool to update a specific entry in the Tave address book. Use when you need to modify contact information, change entry type, or update any fields for an existing address book entry.
Input parameters
ULID of the address book entry to update
Phone number object
Website URL
Type of address book entry: person, company, or location
Primary email address
Gender
Whether the entry is hidden from default views
Whether the entry is pinned for quick access
Physical address
Associated brand ID
Job title
Last name (typically used for person kind)
Birth date
Phone number object
First name (typically used for person kind)
Phone number object
Phone number object
Maiden name
Salutation or title
Anniversary date
Company name (typically used for company kind)
Privacy opt-in status for communications
Mailing address if different from physical address
Whether this contact is a previous client
Secondary email address
Twitter username
Facebook username
Whether strict privacy requirements apply to this contact
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the brand to update
BCC email address for brand communications
The brand's name (4-128 characters)
Brand alias (4-32 characters)
Theme configuration for the brand.
Whether the brand is hidden
Phone number configuration for the brand.
Phone number configuration for the brand.
Phone number configuration for the brand.
Reply-to email address for brand communications
Forward-to email address for brand communications
Shorter name for the brand to be used in constrained UI places (4-128 characters)
ULID of the associated location
Office hours for the brand
Custom domain for the brand
External system mappings for the brand
Whether to enable profile editing
Google Analytics tracking ID (format: UA-XXXXXX-X, YT-XXXXXX-X, or MO-XXXXXX-X)
ULID of the root contact form
Status of the custom domain configuration.
Client access version (1-10)
Whether to show history in the client portal
Whether to break out package pricing
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the event type to update
Event type kind options.
Name of the event type (1-24 characters)
Hex color code for the event type (6 characters, lowercase hex)
Whether the event type is hidden from view
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
Sort position for ordering event types (0-65535)
Default duration for events of this type in minutes (5-86400)
List of default attendee token prefixes (lowercase alphanumeric and underscores, 1-32 chars each)
External system mappings for this event type
ULID of the default location for this event type
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the custom field to update
Enum for the kind of custom field.
Name of the custom field (max 255 characters)
Token identifier for the custom field (max 128 characters)
Whether the custom field is hidden
List of choices for DropDown kind custom fields
Enum for the type of resource the custom field can apply to.
Label displayed to clients (max 255 characters)
Enum for the client access level of the custom field.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the event to update
Name of the event
ULID identifier of the associated job
Whether the event is all-day
Whether the event is hidden from view
ULID identifier of the event type
Event channel type.
End date in YYYY-MM-DD format
End time in 24-hour format (HH:MM:SS)
Event location details.
Whether the event is confirmed
ULID identifier of the associated gallery
Start date in YYYY-MM-DD format
Start time in 24-hour format (HH:MM:SS)
ULID identifier of the timezone
URL for virtual events
Phone number representation.
Timezone name (ignored if timezoneId is provided)
HTML description of the event
External system mappings
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_UPDATE_RESOURCE_GALLERYTool to update a specific gallery in Tave (VSCO Workspace). Use when you need to modify gallery properties such as name, URLs, status, or settings.
Input parameters
ULID identifier of the gallery to update.
The name of this gallery. Required for PUT updates.
The URL path slug for this gallery. Must contain only letters, numbers, dashes, and underscores. Will be converted to lowercase.
A ULID entity identifier for the job this gallery is associated with.
Whether this gallery is hidden.
Whether this gallery is publicly accessible.
Status of a gallery.
A ULID entity identifier for the event this gallery is associated with.
The internal URL of this gallery in the remote admin portal. May be used to link employees to the gallery administration interface in the remote service. Required for PUT updates.
The category of this gallery. Galleries may be grouped by this category text in future client portal designs.
The headline of this gallery. Prioritized over name when displayed to the user.
A reusable plain-text passcode for unlocking the gallery. This pass code may be given to invited users.
The remote ID of this gallery. This value must be unique for the studio. Required for PUT updates.
The URL of this gallery. Will be used for links in emails and the client portal. Required for PUT updates.
The date of the event this gallery is for in YYYY-MM-DD format. Useful in automations or email tokens.
Cover photo details for a gallery.
The date this gallery will be released to the public in YYYY-MM-DD format. Useful in automations or email tokens.
The date that orders for this gallery are due by in YYYY-MM-DD format. Useful in automations or email tokens.
The creation date and time of this gallery in UTC (ISO 8601 format). Required for PUT updates.
The date this gallery will expire and no longer be accessible in YYYY-MM-DD format. Useful in automations or email tokens.
External mappings to relate this gallery to entities in external systems.
Whether this gallery requires a password for access.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job to update
Name of the job that will override the auto-generated title
Stage of the job in the workflow.
Whether the lead or job is closed
Whether the job is favorited/pinned
Whether the lead or job is a sample job
ULID identifier of the brand
Whether the lead or job came from a contact form
Event date in YYYY-MM-DD format (in studio timezone)
ULID identifier of the job type
Notes about the lead
Date when the job was closed in YYYY-MM-DD format (in studio timezone)
Number of guests for the event
Rating for the lead (1-5)
ULID identifier of the workflow
Booking date in YYYY-MM-DD format (in studio timezone)
Inquiry date in YYYY-MM-DD format (in studio timezone)
List of custom field values for the job
Custom job number or identifier
ULID identifier of the lead source
ULID identifier of the lead status
Completion date in YYYY-MM-DD format (in studio timezone)
ULID identifier of the contact form
Maximum budget for the lead in the studio's currency
ULID identifier of the closed reason
Confidence level for a lead.
Fulfillment date in YYYY-MM-DD format (in studio timezone)
List of external system mappings
Expected decision date for the lead in YYYY-MM-DD format (in studio timezone)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job closed reason to update
Name of the job closed reason (1-32 characters)
Whether the job closed reason is hidden from view
Optional description of the job closed reason (max 64 characters)
External system mappings for this job closed reason
Whether this reason should be included in reporting
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job contact to update
ULID identifier of the job
Whether this contact is the primary client for the job
Whether the job contact is hidden from view
List of job role ULID identifiers associated with this contact
ULID identifier of the contact
List of role kinds for this job contact (client, customer, team, subject, vendor)
External system mappings for this job contact
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job role to update
Type/kind of the job role
Name of the job role (1-24 characters)
Whether the job role is hidden from view
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
Sort position for ordering job roles (0-65535)
External system mappings for this job role
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the job type to update
The name of this job type
Whether or not the job type is hidden
ULID identifier of the workflow for this job type
Sort position for ordering job types (0-65535)
List of default event types to associate with this job type
ULID identifier of the profit center for this job type
List of default job roles to associate with this job type
List of external system mappings for this job type
ULID identifier of the initial lead status for this job type
Whether a primary session is required for jobs of this type
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the lead source to update
The name of the lead source. Must be between 3 and 128 characters. This field is required for updates.
Whether or not the lead source is hidden.
A ULID entity identifier for the parent lead source, if this is a nested/child lead source.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the lead status to update
Enum for lead status kind values.
The name of the lead status. Must be between 1 and 64 characters.
Hex color code for the lead status (6 characters, lowercase hex). Example: '278639' for green.
Whether or not the lead status is hidden.
Sort position for ordering lead statuses. Must be between 0 and 65535.
ULID of the lead status to transition to automatically based on time interval.
List of external system mappings for this lead status.
Time interval for automatic transition. Must be between 0 and 99999999999.
Enum for transition interval unit values.
ULID of the closed reason to use when transitioning to a closed status.
ULID of the lead status to transition to after a form is sent.
ULID of the lead status to transition to after an email is sent.
ULID of the lead status to transition to after a quote is sent.
ULID of the lead status to transition to after a document is sent.
ULID of the lead status to transition to after an event is scheduled.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
TAVE_UPDATE_RESOURCE_NOTETool to update a specific note in Tave. Use when you need to modify note content or properties such as associated job, contact, or visibility.
Input parameters
ULID identifier of the note to update
Date string in YYYY-MM-DD format in the timezone of the event or studio.
ULID identifier of the job associated with the note.
Whether or not the note is hidden.
ULID identifier of the author of the note.
ULID identifier of the contact associated with the note.
HTML content of the note. This is a required field.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the order to update
Custom name for the order
Name or auto-generated title of the order
Whether the order is hidden
Status of the order.
Due date for the order in YYYY-MM-DD format
Date when the order was booked in YYYY-MM-DD format
List of line items for the order
ULID identifier of the tax group for calculating taxes
ULID identifier of the recipient from the address book
Custom order number or identifier (max 16 characters)
Reference code for the order (max 11 characters)
ULID identifier of the payment terms
Discount applied to an order.
Whether the order was booked from a quote
Discount applied to an order.
Whether taxes are compounded (tax the tax)
Whether the order was booked electronically
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the profit center to update
The name of the profit center. Must be between 1 and 24 characters.
Whether or not the profit center is hidden.
List of external system mappings for this profit center. These objects cannot be updated currently.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the tax group to update
Name of the tax group (max 64 characters)
Whether the tax group is hidden
Whether this is the default tax group
List of tax rates associated with this tax group (max 3 items)
Whether the tax group uses compounding (taxes applied sequentially)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the tax rate to update
Name of the tax rate (max 32 characters)
The floating point number representing the tax rate percentage. Has 4 points of decimal precision.
Whether the tax rate is hidden from view
Whether the tax is inclusive (included in the price) or exclusive (added to the price)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ULID identifier of the user to update
Whether or not the user is hidden.
Whether or not the user is an admin.
Email address used as username. Must be between 5 and 64 characters.
A lowercase ULID entity identifier for the contact associated with this user.
Whether or not the user has beta access.
Whether or not the user is a billing contact.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Whether to enable or disable readonly mode for the studio. When enabled, the studio will be in readonly mode.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 52 agents privately built on Nagent that already use Tave.
Build on Nagent
Connect Tave to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Tave, and click "Connect Now." You'll authenticate with an API key — Nagent handles credential storage and refresh automatically. Once connected, Tave is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Tave is connected, you configure its 129 actions directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Tave steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Tave event fires, the agent kicks off automatically.
Every Tave action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Tave ships with 129 pre-built crm actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Tave together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Tave-based workflows tailored to your business.