Tave

These are the Tave actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Apply Payment to Order

  Tool 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.

• Create Address Book Entry

  Tool to create an entry in the address book. Use when you need to add a new person, company, or location to the address book.

• Create Job

  Tool to create a new job in Tave (VSCO Workspace). Use when creating leads or jobs for tracking client projects and workflows.

• Create Job Contact

  Tool to create a job contact in Tave. Use when you need to associate a contact with a job.

• Create Job Order

  Tool to create an order on a job in Tave (VSCO Workspace). Use when creating orders for jobs to track sales, invoices, and payments.

• Create Payment

  Tool to create a payment in Tave. Use when recording a payment received for a job.

• Delete Job

  Tool to delete a job by its ULID identifier. Use when you need to permanently remove a job from the system.

• Get Address Book Entity

  Tool 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.

• Get Job

  Tool 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.

• Get Job Contact

  Tool to fetch a specific job contact by ID from Tave. Use when you need to retrieve details about a contact associated with a job.

• Get Order

  Tool 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.

• Get Payment

  Tool 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.

• List Address Book Contacts

  Tool to list contacts in the studio's address book. Use when you need to retrieve all contacts or filter by email with pagination support.

• List Resource Job

  Tool 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.

• List Resource Order

  Tool to get a list of all orders. Use when you need to retrieve orders across all jobs with pagination support.

• List Resource Payment

  Tool to get a list of payments from Tave. Use when you need to retrieve all payments with optional pagination and sorting.

• Update Address Book Entry

  Tool 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.

• Update Job

  Tool to update a specific job in Tave (VSCO Workspace). Use when modifying existing job details like name, dates, stage, or other job properties.

• Update Job Contact

  Tool 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.

• Update Order

  Tool to update a specific order in Tave (VSCO Workspace). Use when modifying existing order details like name, status, line items, or other order properties.

• Create Brand

  Tool to create a new brand in VSCO Workspace. Use when setting up a new brand identity for client-facing portals and communications.

• Create Custom Field

  Tool 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.

• Create Discount

  Tool to create a discount in Tave. Use when you need to add a new discount with a name, price, and type ID.

• Create Discount Type

  Tool 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.

• Create Event

  Tool to create a new event in Tave (VSCO Workspace). Use when scheduling meetings, sessions, or appointments.

• Create Event Type

  Tool to create a new event type in Tave. Use when you need to define a new type of event for scheduling or tracking purposes.

• Create File

  Tool 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.

• Create Gallery

  Tool 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.

• Create Job Closed Reason

  Tool 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.

• Create Job Role

  Tool to create a job role in Tave (VSCO Workspace). Use when defining roles for clients, subjects, team members, or vendors in workflows.

• Create Job Type

  Tool to create a new job type in Tave. Use when defining a new category of jobs for organizing different types of client projects.

• Create Job Worksheet

  Tool to create a job using a worksheet in Tave (VSCO Workspace). Use when creating jobs with pre-populated contacts and events.

• Create Lead Source

  Tool to create a lead source in Tave. Use when you need to track where leads originate from, such as social media, referrals, or websites.

• Create Lead Status

  Tool to create a lead status in Tave. Use when you need to define a new status for tracking leads in the sales pipeline.

• Create Note

  Tool to create a note in Tave (VSCO Workspace). Use when adding notes about jobs, contacts, or other entities in the system.

• Create Product

  Tool to create a product in Tave. Use when you need to add a new product with name and price.

• Create Product Type

  Tool to create a product type in Tave. Use when defining a new category of products or services for organizing offerings in your business.

• Create Profit Center

  Tool to create a profit center in Tave. Use when you need to organize revenue streams or business units for financial tracking and reporting.

• Create RestHook Subscription

  Tool 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.

• Create Tax Rate

  Tool to create a tax rate in Tave. Use when you need to add a new tax rate with a name and rate percentage.

• Create User

  Tool 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.

• Delete Address Book Entry

  Tool 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.

• Delete Brand

  Tool 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.

• Delete Custom Field

  Tool to delete a custom field by its ULID identifier. Use when you need to remove a custom field permanently.

• Delete Discount

  Tool 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.

• Delete Discount Type

  Tool to delete a specific discount type by its ULID. Use when you need to remove a discount type from the system.

• Delete Event

  Tool 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.

• Delete Event Type

  Tool to delete an event type by its ULID identifier. Use when you need to permanently remove an event type from the system.

• Delete Gallery

  Tool to permanently delete a gallery by its ULID. Use when you need to remove a gallery. Returns 204 No Content on success.

• Delete Job Closed Reason

  Tool to delete a job closed reason by its ULID identifier. Use when you need to permanently remove a job closed reason from the system.

• Delete Job Contact

  Tool 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.

• Delete Job Role

  Tool to delete a job role by its ULID identifier. Use when you need to permanently remove a job role from the system.

• Delete Job Type

  Tool 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.

• Delete Lead Source

  Tool to delete a specific lead source by its ULID. Use when you need to permanently remove a lead source from the system.

• Delete Lead Status

  Tool to delete a specific lead status by its ULID. Use when you need to permanently remove a lead status from the system.

• Delete Note

  Tool 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.

• Delete Payment

  Tool 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.

• Delete Product

  Tool 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.

• Delete Product Type

  Tool 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.

• Delete Profit Center

  Tool 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.

• Delete RestHook

  Tool 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.

• Delete Tax Group

  Tool 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.

• Delete Tax Rate

  Tool 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.

• Delete User

  Tool 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.

• Get Address Book Address

  Tool to fetch the address associated with a given location ID. Use when you need to retrieve detailed address information from the Tave address book.

• Get Brand

  Tool 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.

• Get Custom Field

  Tool to fetch a specific custom field by ID from Tave. Use when you need to retrieve details about a custom field definition.

• Get Discount

  Tool 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.

• Get Discount Type

  Tool to get a specific discount type by ID. Use when you need to retrieve details about a particular discount type resource.

• Get Event

  Tool to get a specific event by its ID. Use when you need to retrieve detailed information about a single event.

• Get Event Type

  Tool 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.

• Get Gallery

  Tool 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.

• Get Job Closed Reason

  Tool 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.

• Get Job Role

  Tool 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.

• Get Job Type

  Tool 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.

• Get Job Worksheet

  Tool 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.

• Get Lead Source

  Tool to retrieve a specific lead source by its ID. Use when you need to get detailed information about where a lead originated from.

• Get Lead Status

  Tool 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.

• Get My Studio

  Tool 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.

• Get Note

  Tool 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.

• Get Payment Method

  Tool 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.

• Get Product

  Tool 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.

• Get Product Type

  Tool 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.

• Get Profit Center

  Tool 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.

• Get Tax Rate

  Tool 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.

• Get Timezone

  Tool 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.

• Get User by ID

  Tool 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.

• List Brands

  Tool to list brands of a studio. Use when you need to retrieve all brands configured for the studio account.

• List Discount Types

  Tool to get a list of discount types from Tave. Use when you need to retrieve available discount types for your account.

• List Event Types

  Tool to list a studio's event types. Use when you need to retrieve all available event types for a studio.

• List Files

  Tool 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.

• List Galleries

  Tool to list all galleries for a studio. Use when you need to retrieve galleries with optional filtering and pagination.

• List Job Closed Reasons

  Tool to list a studio's job closed reasons. Use when you need to retrieve all job closed reasons configured for the studio account.

• List Job Payments

  Tool to get a list of payments for a specific job. Use when you need to retrieve payment information associated with a particular job.

• List Job Roles

  Tool to list a studio's job roles. Use when you need to retrieve all job roles configured for the studio account.

• List Product Types

  Tool to get a list of product types from Tave. Use when you need to retrieve all available product types.

• List Resource Custom Fields

  Tool 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.

• List Resource Discount

  Tool to get a list of discounts from Tave. Use when you need to retrieve all available discounts.

• List Resource Job Contact

  Tool 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.

• List Resource Job Orders

  Tool to list orders on a given job. Use when you need to retrieve all orders associated with a specific job.

• List Resource Job Type

  Tool 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.

• List Resource Lead Source

  Tool to list lead sources of a studio. Use when you need to retrieve all lead sources for tracking where leads originated from.

• List Resource Lead Status

  Tool 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.

• List Resource Note

  Tool to list notes from Tave. Use when you need to retrieve notes associated with jobs or contacts, with support for pagination and filtering.

• List Resource Payment Method

  Tool to get a list of payment methods from Tave. Use when you need to retrieve all available payment methods.

• List Resource Product

  Tool to get a list of products from Tave. Use when you need to retrieve all products with optional sorting.

• List Resource Profit Center

  Tool to list profit centers of a studio. Use when you need to retrieve all available profit centers for tracking business segments or cost centers.

• List Resource Tax Groups

  Tool to get a list of Tax Groups from Tave. Use when you need to retrieve available tax groups for tax calculations.

• List Resource Tax Rates

  Tool to get a list of tax rates from Tave. Use when you need to retrieve all available tax rates for your account.

• List Resource Timezone

  Tool to get a list of timezones from Tave. Use when you need to retrieve available timezones for scheduling or location-based operations.

• List Resource User

  Tool to list users of a studio. Use when you need to retrieve all users for the studio account with optional pagination and sorting.

• List REST Hooks

  Tool to list REST hooks configured in Tave. Use when you need to retrieve webhook registrations that notify external services of events.

• List Studio Events

  Tool 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.

• Update Brand

  Tool 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.

• Update Custom Field

  Tool to update a specific custom field in Tave. Use when you need to modify custom field properties like name, kind, client access, or visibility.

• Update Event

  Tool to update a specific event in Tave. Use when modifying event details such as name, date/time, location, channel, or other event attributes.

• Update Event Type

  Tool 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).

• Update Gallery

  Tool to update a specific gallery in Tave (VSCO Workspace). Use when you need to modify gallery properties such as name, URLs, status, or settings.

• Update Job Closed Reason

  Tool 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.

• Update Job Role

  Tool 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.

• Update Job Type

  Tool to update an existing job type in Tave. Use when modifying properties of a job category such as name, visibility, or associated defaults.

• Update Lead Source

  Tool to update a specific lead source in Tave. Use when you need to modify lead source properties such as name, parent relationship, or visibility.

• Update Lead Status

  Tool 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.

• Update Note

  Tool to update a specific note in Tave. Use when you need to modify note content or properties such as associated job, contact, or visibility.

• Update Profit Center

  Tool to update a specific profit center in Tave. Use when you need to modify an existing profit center's name or visibility settings.

• Update Studio Readonly Mode

  Tool to set studio readonly mode in Tave. Use when you need to enable or disable readonly mode for the authenticated studio.

• Update Tax Group

  Tool 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.

• Update Tax Rate

  Tool 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.

• Update User

  Tool 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.