The VSCO Workspace (Tave) connector lets your AI agent act in each user's VSCO Workspace (Tave) account. Each user connects their own VSCO Workspace (Tave) API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 165 tools.
- Tools
- 165
- What they doRead · write · destructive
- 75 · 63 · 2775 read63 write27 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the VSCO Workspace (Tave) connection
In AgentKit > Connections, create a VSCO Workspace (Tave) connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'tave'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize VSCO Workspace (Tave):', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'tave_brands_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "tave"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize VSCO Workspace (Tave):", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="tave_brands_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their VSCO Workspace (Tave) credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_tooltave_brand_getGet one brand by ID.Read-onlyGet Brand
Get one brand by ID. Returns the brand with name, alias, emails, phones, office hours, custom domain and theme colors. Use tave_brand_get when you have the ID. Use tave_brands_list to browse brands.
Inputs
idstringrequired- ULID of the brand. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_brands_listList the studio's brands (the business identities used on client-facing pages and emails).Read-onlyList Brands
List the studio's brands (the business identities used on client-facing pages and emails). Returns the page of brands with id, name, alias, contact emails, phones and theme. Use tave_brands_list to find a brand_id for tave_job_create or tave_contact_create. Use tave_brand_get for one brand by ID.
Inputs
external_mapping_idstring- Only objects linked to this ID in an external system (external mapping ID, up to 64 characters). Example: crm-1234.
include_hiddenboolean- true to include hidden brands. Example: false.
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page, from 10 to 100 (default 100). Example: 50.
sort_bystring- Sort order: id, modified, created or name, optionally followed by asc or desc (default id). Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_contact_getGet one address book entry by ID.Read-onlyGet Address Book Entry
Get one address book entry by ID. Returns the contact with name, emails, phones, address, custom fields and jobs. Use tave_contact_get when you have the ID.
Inputs
idstringrequired- ULID of the address book entry. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
tave_contacts_listList address book entries (people, companies and locations), optionally by email.Read-onlyList Address Book
List address book entries (people, companies and locations), optionally by email. Returns the page of contacts with id, kind, name, email and phones. Use tave_contacts_list to browse or match an email. Use tave_search for free-text search.
Inputs
emailstring- Email address to match; results are ranked by match. Example: jamie@example.com.
include_hiddenboolean- true to include hidden entries. Example: false.
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
sort_bystring- Sort order: id, modified, created, name, kind, accountBalance, anniversary, anonymized, bestDayToCall, bestTimeToCall, cellPhone, companyName, contactPreference, creditBalance, email, fax, firstName, gender, homePhone, jobTitle, lastName, maidenName, previousClient, privacyOptIn, requireStrictPrivacy, salutation, schoolGradYear, schoolName, sport, teamName, teamPosition or workPhone, optionally followed by asc or desc (default id). Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desckindkind asckind descaccountBalanceaccountBalance ascaccountBalance descanniversaryanniversary ascanniversary descanonymizedanonymized ascanonymized descbestDayToCallbestDayToCall ascbestDayToCall descbestTimeToCallbestTimeToCall ascbestTimeToCall desccellPhonecellPhone asccellPhone desccompanyNamecompanyName asccompanyName desccontactPreferencecontactPreference asccontactPreference desccreditBalancecreditBalance asccreditBalance descemailemail ascemail descfaxfax ascfax descfirstNamefirstName ascfirstName descgendergender ascgender deschomePhonehomePhone aschomePhone descjobTitlejobTitle ascjobTitle desclastNamelastName asclastName descmaidenNamemaidenName ascmaidenName descpreviousClientpreviousClient ascpreviousClient descprivacyOptInprivacyOptIn ascprivacyOptIn descrequireStrictPrivacyrequireStrictPrivacy ascrequireStrictPrivacy descsalutationsalutation ascsalutation descschoolGradYearschoolGradYear ascschoolGradYear descschoolNameschoolName ascschoolName descsportsport ascsport descteamNameteamName ascteamName descteamPositionteamPosition ascteamPosition descworkPhoneworkPhone ascworkPhone desc
tave_contract_getGet one contract by ID.Read-onlyGet Contract
Get one contract by ID. Returns the contract with status, signatures and clientUrl. Use tave_contract_get to check whether a contract was signed.
Inputs
idstringrequired- ULID of the contract. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_custom_field_getGet one custom field definition by ID.Read-onlyGet Custom Field
Get one custom field definition by ID. Returns the field with name, kind, canApplyTo, clientAccess, clientLabel, choices and token. Use tave_custom_field_get when you have the ID. Use tave_custom_fields_list to browse fields.
Inputs
idstringrequired- ULID of the custom field. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_custom_fields_listList the studio's custom fields for jobs and contacts, optionally by record type or kind.Read-onlyList Custom Fields
List the studio's custom fields for jobs and contacts, optionally by record type or kind. Returns custom fields with id, name, kind, canApplyTo, clientAccess, choices and token. Use tave_custom_fields_list to find which custom fields exist. Use tave_custom_field_get for one field by ID.
Inputs
can_apply_tostring- Only custom fields that apply to this record type: contact or job. Example: job.one of
contactjob kindarray- Only custom fields of these kinds: textfield, textbox, number, money, checkbox, date, decimal, dropdown, time. Example: ["dropdown", "date"].
sort_bystring- Sort order: id, modified, created or name, optionally followed by asc or desc (default id). Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_discount_getGet one discount by ID.Read-onlyGet Discount
Get one discount by ID. Returns the discount with name, typeId, kind, price, description, sku and rebate flag. Use tave_discount_get when you have the ID. Use tave_discounts_list to browse discounts.
Inputs
idstringrequired- ULID of the discount. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_discount_type_getGet one discount type by ID.Read-onlyGet Discount Type
Get one discount type by ID. Returns the discount type with name and parentId. Use tave_discount_type_get when you have the ID. Use tave_discount_types_list to browse types.
Inputs
idstringrequired- ULID of the discount type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_discount_types_listList the studio's discount types (categories that group discounts).Read-onlyList Discount Types
List the studio's discount types (categories that group discounts). Returns discount types with id, name and parentId. Use tave_discount_types_list to get a type_id for tave_discount_create. Use tave_discounts_list for the discounts themselves.
Inputs
sort_bystring- Sort order: id, modified, created or name, optionally followed by asc or desc (default id). Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_discounts_listList the studio's discounts.Read-onlyList Discounts
List the studio's discounts. Returns discounts with id, name, typeId, kind, price, sku and rebate flag. Use tave_discounts_list to find a discount. Use tave_discount_get for one discount by ID; use tave_discount_types_list for discount categories.
Inputs
sort_bystring- Sort order: id, modified, created or name, optionally followed by asc or desc (default id). Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_event_getGet one event by ID.Read-onlyGet Event
Get one event by ID. Returns the event with type, times, timezone, location and job. Use tave_event_get when you have the ID.
Inputs
idstringrequired- ULID of the event. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_event_type_getGet one event type by ID.Read-onlyGet Event Type
Get one event type by ID. Returns the event type with name, kind, color, default duration, attendees, location and tokenPrefix. Use tave_event_type_get when you have the ID. Use tave_event_types_list to browse types.
Inputs
idstringrequired- ULID of the event type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_event_types_listList the studio's event types (for example engagement session, consultation, wedding).Read-onlyList Event Types
List the studio's event types (for example engagement session, consultation, wedding). Returns event types with id, name, kind, color, default duration and tokenPrefix. Use tave_event_types_list to get the type_id for tave_event_create. Use tave_event_type_get for one type by ID.
Inputs
external_mapping_idstring- Only objects linked to this ID in an external system (external mapping ID, up to 64 characters). Example: crm-1234.
include_hiddenboolean- true to include hidden event types. Example: false.
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page, from 10 to 100 (default 100). Example: 50.
sort_bystring- Sort order: id, modified, created or name, optionally followed by asc or desc (default id). Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_events_listList calendar events (sessions, meetings, weddings), by job or date range.Read-onlyList Events
List calendar events (sessions, meetings, weddings), by job or date range. Returns events with id, name, type, start, end, location and job. Use tave_events_list for a schedule.
Inputs
job_idstring- Only records attached to this job ID. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
occurs_fromstring- Only events ending on or after this date (YYYY-MM-DD). Example: 2026-12-01.
occurs_tostring- Only events starting on or before this date (YYYY-MM-DD). Example: 2026-12-31.
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
sort_bystring- Sort order: id, modified, created, name or startDate, optionally followed by asc or desc (default id). Example: startDate asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname descstartDatestartDate ascstartDate desc
tave_file_getGet one file by ID.Read-onlyGet File
Get one file by ID. Returns the file with filename, name, description, MIME type, size, download URL, file type and attachments. Use tave_file_get when you already have the ID. Use tave_files_list to find files on a job or contact.
Inputs
idstringrequired- ULID of the file. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_file_type_getGet one file type by ID.Read-onlyGet File Type
Get one file type by ID. Returns the file type with id, code name, name and description. Use tave_file_type_get when you already have the ID. Use tave_file_types_list to browse file types.
Inputs
idstringrequired- ULID of the file type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_file_types_listList the studio's file types (the purpose categories files can be given).Read-onlyList File Types
List the studio's file types (the purpose categories files can be given). Returns the page of file types with id, code name, name and description. Use tave_file_types_list to get type_id for tave_file_create or tave_file_update. Use tave_file_type_get for one file type.
Inputs
include_hiddenboolean- true to include hidden (archived) records (default false). Example: false.
pageinteger- Page of results, starting at 1 (default 1). Example: 1.
page_sizeinteger- Results per page, from 10 to 100 (default 100). Example: 50.
sort_bystring- Property to sort by (id, modified, created, name), optionally followed by a space and asc or desc. Default id. Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_files_listList the studio's files, optionally filtered by job or contact.Read-onlyList Files
List the studio's files, optionally filtered by job or contact. Returns the page of files with id, filename, name, MIME type, size, URL, file type and attachments. Use tave_files_list to find files on a job or contact. Use tave_file_get for one file by ID and tave_galleries_list for client photo galleries.
Inputs
contact_idstring- Only files attached to this address book contact (ULID). Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
external_mapping_idstring- Only records linked to this ID in your external system (set through an integration). Example: crm-12345.
include_hiddenboolean- true to include hidden (archived) records (default false). Example: false.
job_idstring- Only files attached to this job (ULID). Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
pageinteger- Page of results, starting at 1 (default 1). Example: 1.
page_sizeinteger- Results per page, from 10 to 100 (default 100). Example: 50.
sort_bystring- Property to sort by (id, modified, created, name), optionally followed by a space and asc or desc. Default id. Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_galleries_listList the studio's client galleries, optionally by name.Read-onlyList Galleries
List the studio's client galleries, optionally by name. Returns galleries with id, name, job and status. Use tave_galleries_list to find a gallery.
Inputs
namestring- Text the gallery name contains. Example: Rivera.
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
sort_bystring- Sort order: id, modified, created or name, optionally followed by asc or desc (default name asc). Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_gallery_getGet one client gallery by ID.Read-onlyGet Gallery
Get one client gallery by ID. Returns the gallery with name, status, URLs, job, event, dates, passcode settings and photo, order and visitor counts. Use tave_gallery_get when you already have the ID. Use tave_galleries_list to find a gallery by name.
Inputs
idstringrequired- ULID of the gallery. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_invoice_getGet one invoice (order installment) by ID.Read-onlyGet Invoice
Get one invoice (order installment) by ID. Returns the invoice with amount, due date, status and payments. Use tave_invoice_get when you have the ID.
Inputs
idstringrequired- ULID of the invoice. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_invoices_listList invoices (order installments), by status, due date range, job or past-due state.Read-onlyList Invoices
List invoices (order installments), by status, due date range, job or past-due state. Returns invoices with amount, due date, status, order and job. Use tave_invoices_list with past_due true to chase late payments.
Inputs
due_fromstring- Only invoices due on or after this date (YYYY-MM-DD). Example: 2026-11-01.
due_tostring- Only invoices due on or before this date (YYYY-MM-DD). Example: 2026-11-30.
job_idstring- Only records attached to this job ID. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
past_dueboolean- true for open invoices that are past due. Example: true.
sort_bystring- Sort order: id, modified, created, name, sortPosition or dueDate, optionally followed by asc or desc (default sortPosition). Example: dueDate asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname descsortPositionsortPosition ascsortPosition descdueDatedueDate ascdueDate desc statusstring- Comma-separated statuses to include, for example draft,open. Example: open.
tave_job_closed_reason_getGet one job closed reason by ID.Read-onlyGet Job Closed Reason
Get one job closed reason by ID. Returns the closed reason with name, description and whether it counts in reporting. Use tave_job_closed_reason_get when you already have the ID. Use tave_job_closed_reasons_list to browse reasons.
Inputs
idstringrequired- ULID of the job closed reason. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_job_closed_reasons_listList the studio's job closed reasons (why a lead or job was closed).Read-onlyList Job Closed Reasons
List the studio's job closed reasons (why a lead or job was closed). Returns the page of closed reasons with id, name, description and whether each counts in reporting. Use tave_job_closed_reasons_list to get closed_reason_id for tave_job_update. Use tave_job_closed_reason_get for one reason.
Inputs
external_mapping_idstring- Only records linked to this ID in your external system (set through an integration). Example: crm-12345.
include_hiddenboolean- true to include hidden (archived) records (default false). Example: false.
pageinteger- Page of results, starting at 1 (default 1). Example: 1.
page_sizeinteger- Results per page, from 10 to 100 (default 100). Example: 50.
sort_bystring- Property to sort by (id, modified, created, name), optionally followed by a space and asc or desc. Default id. Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_job_contact_getGet one job contact (the link between a job and an address book contact) by ID.Read-onlyGet Job Contact
Get one job contact (the link between a job and an address book contact) by ID. Returns the job contact with job id, contact id, client flag, job roles and role kinds. Use tave_job_contact_get when you already have the ID. Use tave_job_contacts_list to find the contacts on a job and tave_contact_get for the person's details.
Inputs
idstringrequired- ULID of the job contact. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_job_contacts_listList the contacts linked to jobs, by job or by contact.Read-onlyList Job Contacts
List the contacts linked to jobs, by job or by contact. Returns job contacts with jobId, contactId, client flag and roles. Use tave_job_contacts_list to see who is on a job.
Inputs
contact_idstring- Only links for this contact ID. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
job_idstring- Only records attached to this job ID. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
sort_bystring- Sort order: id, modified or created, optionally followed by asc or desc (default id). Example: created desc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated desc
tave_job_getGet one job by ID.Read-onlyGet Job
Get one job by ID. Returns the job with name, stage, dates, lead details, totals and balances. Use tave_job_get for job details.
Inputs
idstringrequired- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
tave_job_orders_listList the orders (booked packages and invoices) on a job.Read-onlyList Job Orders
List the orders (booked packages and invoices) on a job. Returns orders with id, status, totals and balance. Use tave_job_orders_list before applying a payment with tave_payment_apply.
Inputs
job_idstringrequired- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
sort_bystring- Sort order: id, modified, created, name, sortPosition or dueDate, optionally followed by asc or desc (default sortPosition). Example: created desc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname descsortPositionsortPosition ascsortPosition descdueDatedueDate ascdueDate desc
tave_job_payments_listList the payments on a job.Read-onlyList Job Payments
List the payments on a job. Returns payments with amount, status, received date and method. Use tave_job_payments_list to check what a client has paid.
Inputs
idstringrequired- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
sort_bystring- Sort order: id, modified or created, optionally followed by asc or desc (default id). Example: created desc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated desc
tave_job_role_getGet one job role by ID.Read-onlyGet Job Role
Get one job role by ID. Returns the job role with name, kind, token prefix and sort position. Use tave_job_role_get when you already have the ID. Use tave_job_roles_list to browse roles.
Inputs
idstringrequired- ULID of the job role. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_job_roles_listList the studio's job roles (for example Bride, Groom, Planner, Second Shooter).Read-onlyList Job Roles
List the studio's job roles (for example Bride, Groom, Planner, Second Shooter). Returns the page of job roles with id, name, kind, token prefix and sort position. Use tave_job_roles_list to get job role IDs for tave_job_contact_create or tave_job_contact_update. Use tave_job_role_get for one role.
Inputs
external_mapping_idstring- Only records linked to this ID in your external system (set through an integration). Example: crm-12345.
include_hiddenboolean- true to include hidden (archived) records (default false). Example: false.
pageinteger- Page of results, starting at 1 (default 1). Example: 1.
page_sizeinteger- Results per page, from 10 to 100 (default 100). Example: 50.
sort_bystring- Property to sort by (id, modified, created, name, sortPosition), optionally followed by a space and asc or desc. Default sortPosition. Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname descsortPositionsortPosition ascsortPosition desc
tave_job_type_getGet one job type by ID.Read-onlyGet Job Type
Get one job type by ID. Returns the job type with name, initial lead status, profit center, workflow, default contacts and default events. Use tave_job_type_get when you already have the ID. Use tave_job_types_list to browse job types.
Inputs
idstringrequired- ULID of the job type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_job_types_listList the studio's job types.Read-onlyList Job Types
List the studio's job types. Returns job types with id and name. Use tave_job_types_list to get job_type_id for tave_job_create.
Inputs
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
tave_job_worksheet_getGet a job's worksheet: its contacts, events and custom fields in one document.Read-onlyGet Job Worksheet
Get a job's worksheet: its contacts, events and custom fields in one document. Returns the worksheet. Use tave_job_worksheet_get for a full job overview.
Inputs
job_idstringrequired- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
tave_jobs_listList jobs and leads, filtered by stage, lead status, event date range or stale date.Read-onlyList Jobs
List jobs and leads, filtered by stage, lead status, event date range or stale date. Returns the page of jobs with id, name, stage, event date, lead status and totals. Use tave_jobs_list to find a job or pipeline. Use tave_search for free text.
Inputs
event_date_fromstring- Only jobs with an event on or after this date (YYYY-MM-DD). Example: 2027-01-01.
event_date_tostring- Only jobs with an event on or before this date (YYYY-MM-DD). Example: 2027-12-31.
include_closedboolean- true to include closed jobs. Example: false.
lead_status_idstring- Only jobs with this lead status ID. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
sort_bystring- Sort order: id, modified, created, name, accountBalance, bookingDate, closed, closedDate, completedDate, creditBalance, customNumber, eventDate, fulfillmentDate, guestCount, inquiryDate, lastClientActivity, leadConfidence, leadDecisionExpectedByDate, leadMaxBudget, leadRating, leadStatusChangedAt, pinned, previousInteractionDate, stage, staleDate, title, totalCost, totalGratuity, totalProfit, totalRevenue or webLead, optionally followed by asc or desc (default id). Example: eventDate desc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname descaccountBalanceaccountBalance ascaccountBalance descbookingDatebookingDate ascbookingDate descclosedclosed ascclosed descclosedDateclosedDate ascclosedDate desccompletedDatecompletedDate asccompletedDate desccreditBalancecreditBalance asccreditBalance desccustomNumbercustomNumber asccustomNumber desceventDateeventDate asceventDate descfulfillmentDatefulfillmentDate ascfulfillmentDate descguestCountguestCount ascguestCount descinquiryDateinquiryDate ascinquiryDate desclastClientActivitylastClientActivity asclastClientActivity descleadConfidenceleadConfidence ascleadConfidence descleadDecisionExpectedByDateleadDecisionExpectedByDate ascleadDecisionExpectedByDate descleadMaxBudgetleadMaxBudget ascleadMaxBudget descleadRatingleadRating ascleadRating descleadStatusChangedAtleadStatusChangedAt ascleadStatusChangedAt descpinnedpinned ascpinned descpreviousInteractionDatepreviousInteractionDate ascpreviousInteractionDate descstagestage ascstage descstaleDatestaleDate ascstaleDate desctitletitle asctitle desctotalCosttotalCost asctotalCost desctotalGratuitytotalGratuity asctotalGratuity desctotalProfittotalProfit asctotalProfit desctotalRevenuetotalRevenue asctotalRevenue descwebLeadwebLead ascwebLead desc stagestring- Comma-separated stages to include: lead, booked, fulfillment, completed. Example: lead,booked.
tave_lead_source_getGet one lead source by ID.Read-onlyGet Lead Source
Get one lead source by ID. Returns the lead source with id, name, parent ID and hidden flag. Use tave_lead_source_get for one source. Use tave_lead_sources_list to browse sources or find an ID.
Inputs
idstringrequired- ULID of the lead source. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_lead_sources_listList the studio's lead sources.Read-onlyList Lead Sources
List the studio's lead sources. Returns lead sources with id and name. Use tave_lead_sources_list to get lead_source_id for tave_job_create.
Inputs
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
tave_lead_status_getGet one lead status by ID.Read-onlyGet Lead Status
Get one lead status by ID. Returns the lead status with name, kind, color, sort position and its automatic transition settings. Use tave_lead_status_get for one status. Use tave_lead_statuses_list to browse statuses or find an ID.
Inputs
idstringrequired- ULID of the lead status. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_lead_statuses_listList the studio's lead statuses.Read-onlyList Lead Statuses
List the studio's lead statuses. Returns lead statuses with id and name. Use tave_lead_statuses_list to filter or set a lead's status.
Inputs
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
tave_location_address_getGet the street address of a location entry in the address book.Read-onlyGet Location Address
Get the street address of a location entry in the address book. Returns the address with street, city, state, postal code, country code and country name. Use tave_location_address_get for just the address of a venue. Use tave_contact_get for the full address book entry.
Inputs
idstringrequired- ULID of the address book entry of kind location (from tave_contacts_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_mail_message_getGet one email message by ID.Read-onlyGet Mail Message
Get one email message by ID. Returns the message with subject, body, sender, recipients and attachments. Use tave_mail_message_get to read a full email.
Inputs
idstringrequired- ULID of the mail message. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_mail_messages_listList the email messages of a job, by direction, send status or thread.Read-onlyList Job Mail Messages
List the email messages of a job, by direction, send status or thread. Returns messages with subject, from, to, when, kind and sendStatus. Use tave_mail_messages_list to read client correspondence.
Inputs
job_idstringrequired- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
kindstring- Message direction. Example: Incoming.one of
IncomingOutgoingBCC pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
send_statusstring- Send status. Example: Sent.one of
DraftQueuedSent sort_bystring- Sort order: when, id, modified or created, optionally followed by asc or desc (default when desc). Example: when desc.one of
whenwhen ascwhen descidid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated desc thread_idstring- Only this conversation thread ID. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_note_getGet one note by ID.Read-onlyGet Note
Get one note by ID. Returns the note with its HTML content, date, and linked job and contact. Use tave_note_get to read one note. Use tave_notes_list to find notes on a job or contact.
Inputs
idstringrequired- ULID of the note. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
expandstring- Related object to include inline: Note.author adds the author's contact record. Example: Note.author.one of
Note.author
tave_notes_listList notes, optionally for a job.Read-onlyList Notes
List notes, optionally for a job. Returns notes with contentHtml, date, author, job and contact. Use tave_notes_list to read a job's history.
Inputs
job_idstring- Only records attached to this job ID. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
sort_bystring- Sort order: id, modified or created, optionally followed by asc or desc (default id). Example: created desc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated desc
tave_order_getGet one order by ID.Read-onlyGet Order
Get one order by ID. Returns the order with line items, totals, taxes, installments and balance. Use tave_order_get for order details.
Inputs
idstringrequired- ULID of the order. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_orders_listList orders across the studio.Read-onlyList Orders
List orders across the studio. Returns orders with job, status, totals and balance. Use tave_orders_list for sales; use tave_job_orders_list for one job.
Inputs
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
sort_bystring- Sort order: id, modified, created, name, sortPosition or dueDate, optionally followed by asc or desc (default sortPosition). Example: created desc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname descsortPositionsortPosition ascsortPosition descdueDatedueDate ascdueDate desc
tave_payment_getGet one payment by ID.Read-onlyGet Payment
Get one payment by ID. Returns the payment with amount, refunded amount, status, received date, payer, payment method, allocations and refunds. Use tave_payment_get for one payment. Use tave_payments_list or tave_job_payments_list to find payments.
Inputs
idstringrequired- ULID of the payment. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_payment_method_getGet one payment method by ID.Read-onlyGet Payment Method
Get one payment method by ID. Returns the payment method with id, name and kind (Cash, Check, CreditCard, EFT, PayPal or Google). Use tave_payment_method_get to check one method. Use tave_payment_methods_list to find a payment_method_id.
Inputs
idstringrequired- ULID of the payment method. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_payment_methods_listList the studio's payment methods.Read-onlyList Payment Methods
List the studio's payment methods. Returns methods with id and name. Use tave_payment_methods_list to get payment_method_id for tave_payment_create.
Inputs
sort_bystring- Sort order: id, modified, created or sortPosition, optionally followed by asc or desc (default sortPosition). Example: created desc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descsortPositionsortPosition ascsortPosition desc
tave_payments_listList payments across the studio.Read-onlyList Payments
List payments across the studio. Returns payments with job, amount, status, received date and method. Use tave_payments_list for cash flow; use tave_job_payments_list for one job.
Inputs
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
sort_bystring- Sort order: id, modified or created, optionally followed by asc or desc (default id). Example: created desc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated desc
tave_product_getGet one product by ID.Read-onlyGet Product
Get one product by ID. Returns the product with price, description, tax and expenses. Use tave_product_get when you have the ID.
Inputs
idstringrequired- ULID of the product. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_product_type_getGet one product type by ID.Read-onlyGet Product Type
Get one product type by ID. Returns the product type with id, name, kind and parent ID. Use tave_product_type_get for one type. Use tave_product_types_list to browse types or find an ID.
Inputs
idstringrequired- ULID of the product type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_product_types_listList the studio's product types, the categories products belong to.Read-onlyList Product Types
List the studio's product types, the categories products belong to. Returns product types with id, name, kind (Session, Album, Print, Service or Other) and parent ID. Use tave_product_types_list to find the type ID for tave_product_create or tave_product_update. Use tave_product_type_get for one type.
Inputs
sort_bystring- Property to sort by: id, modified, created or name, optionally followed by asc or desc. Defaults to id. Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_products_listList the studio's products and services.Read-onlyList Products
List the studio's products and services. Returns products with name, price, sku and taxable. Use tave_products_list to find product IDs for quotes.
Inputs
sort_bystring- Sort order: id, modified, created or name, optionally followed by asc or desc (default id). Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_profit_center_getGet one profit center by ID.Read-onlyGet Profit Center
Get one profit center by ID. Returns the profit center with id, name and hidden flag. Use tave_profit_center_get for one profit center. Use tave_profit_centers_list to browse or find IDs.
Inputs
idstringrequired- ULID of the profit center. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_profit_centers_listList the studio's profit centers, the revenue categories products are reported under.Read-onlyList Profit Centers
List the studio's profit centers, the revenue categories products are reported under. Returns the page of profit centers with id, name and hidden flag. Use tave_profit_centers_list to find a profit center ID. Use tave_profit_center_get for one profit center by ID.
Inputs
external_mapping_idstring- Only profit centers linked to this ID in an external system, up to 64 characters. Example: qb-income-4000.
include_hiddenboolean- true to include hidden (archived) entries. Defaults to false. Example: false.
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page, from 10 to 100. Defaults to 100. Example: 50.
sort_bystring- Property to sort by, optionally followed by asc or desc: id, modified, created, name. Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_quote_getGet one quote by ID.Read-onlyGet Quote
Get one quote by ID. Returns the quote with options, prices, recipients and status. Use tave_quote_get before booking or sending a quote.
Inputs
idstringrequired- ULID of the quote. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_quotes_listList quotes across the studio.Read-onlyList Quotes
List quotes across the studio. Returns quotes with job, name, status, expiration and options. Use tave_quotes_list to follow up on open quotes.
Inputs
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
sort_bystring- Sort order: id, modified, created or name, optionally followed by asc or desc (default id). Example: created desc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_rest_hook_getGet one REST Hook webhook subscription by ID.Read-onlyGet REST Hook
Get one REST Hook webhook subscription by ID. Returns the subscription with id, event, target url and limitTo filters. Use tave_rest_hook_get to inspect a subscription. Use tave_rest_hooks_list to find IDs.
Inputs
idstringrequired- ULID of the REST Hook subscription. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_rest_hooks_listList the studio's REST Hook webhook subscriptions.Read-onlyList REST Hooks
List the studio's REST Hook webhook subscriptions. Returns the page of subscriptions with id, event, target url and limitTo filters. Use tave_rest_hooks_list to audit or find a subscription ID. Use tave_rest_hook_get for one subscription.
Inputs
include_hiddenboolean- true to include hidden (archived) entries. Defaults to false. Example: false.
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page, from 10 to 100. Defaults to 100. Example: 50.
sort_bystring- Property to sort by, optionally followed by asc or desc: id, modified, created. Example: created desc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated desc
tave_searchFree-text search within one resource type: jobs, contacts, events, notes, orders, payments or addresses.Read-onlySearch Studio
Free-text search within one resource type: jobs, contacts, events, notes, orders, payments or addresses. Returns ranked matches of that type. Use tave_search when you know a name or phrase but not the ID.
Inputs
qstringrequired- Text to search for. Example: Rivera.
scopestringrequired- Resource type to search. Example: job.one of
jobcontacteventnoteorderpaymentaddress
tave_studio_getGet the studio the API key belongs to.Read-onlyGet My Studio
Get the studio the API key belongs to. Returns the studio with name, currency, timezone and settings. Use tave_studio_get to check the connection and the studio's currency.
Inputs
This tool takes no inputs.
tave_task_getGet one task by ID.Read-onlyGet Task
Get one task by ID. Returns the task with name, due date, assignee and completion. Use tave_task_get when you have the ID.
Inputs
idstringrequired- ULID of the task. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_task_list_getGet one task list (a job workflow checklist) by ID.Read-onlyGet Task List
Get one task list (a job workflow checklist) by ID. Returns the task list with id, name, jobId, userId, dueDate, stage, completed and starred. Use tave_task_list_get for one task list. Use tave_task_lists_list to find IDs and tave_tasks_list with task_list_id for its tasks.
Inputs
idstringrequired- ULID of the task list. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_task_lists_listList the studio's task lists.Read-onlyList Task Lists
List the studio's task lists. Returns task lists with id and name. Use tave_task_lists_list to get the task_list_id for tave_task_create.
Inputs
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
tave_tasks_listList tasks, filtered by job, task list, assignee or completion.Read-onlyList Tasks
List tasks, filtered by job, task list, assignee or completion. Returns tasks with name, dueDate, completed, user and job. Use tave_tasks_list for to-dos.
Inputs
completedboolean- true for done tasks, false for open tasks. Example: false.
job_idstring- Only records attached to this job ID. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
sort_bystring- Sort order: id, modified, created, name or sortPosition, optionally followed by asc or desc (default sortPosition). Example: created desc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname descsortPositionsortPosition ascsortPosition desc task_list_idstring- Only tasks in this task list ID. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
user_idstring- Only tasks assigned to this user ID. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_tax_group_getGet one tax group by ID.Read-onlyGet Tax Group
Get one tax group by ID. Returns the tax group with id, name, taxRates, compounding and default. Use tave_tax_group_get for one tax group. Use tave_tax_groups_list to find IDs.
Inputs
idstringrequired- ULID of the tax group. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_tax_groups_listList the studio's tax groups (sets of up to 3 tax rates applied together).Read-onlyList Tax Groups
List the studio's tax groups (sets of up to 3 tax rates applied together). Returns tax groups with id, name, taxRates, compounding and default. Use tave_tax_groups_list to find a tax group ID. Use tave_tax_rates_list for individual rates.
Inputs
sort_bystring- Property to sort by, optionally followed by asc or desc: id, modified, created, name. Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_tax_rate_getGet one tax rate by ID.Read-onlyGet Tax Rate
Get one tax rate by ID. Returns the tax rate with id, name, rate (percentage) and inclusive. Use tave_tax_rate_get for one tax rate. Use tave_tax_rates_list to find IDs.
Inputs
idstringrequired- ULID of the tax rate. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_tax_rates_listList the studio's tax rates.Read-onlyList Tax Rates
List the studio's tax rates. Returns tax rates with id, name, rate (percentage) and inclusive. Use tave_tax_rates_list to find a tax rate ID. Use tave_tax_groups_list for grouped rates.
Inputs
sort_bystring- Property to sort by, optionally followed by asc or desc: id, modified, created, name. Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname desc
tave_timezone_getGet one timezone by ID.Read-onlyGet Timezone
Get one timezone by ID. Returns the timezone with name, displayName, code, daylightCode, city, country and region. Use tave_timezone_get to resolve a timezoneId (for example from tave_studio_get). Use tave_timezones_list to search.
Inputs
idstringrequired- ULID of the timezone. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_timezones_listList the timezones VSCO Workspace supports, optionally searched by name, code or country.Read-onlyList Timezones
List the timezones VSCO Workspace supports, optionally searched by name, code or country. Returns the page of timezones with id, name (for example America/New_York), displayName, code, country and region. Use tave_timezones_list to find a timezone ID for tave_studio_update. Use tave_timezone_get for one timezone by ID.
Inputs
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page, from 10 to 100. Defaults to 100. Example: 50.
searchstring- Text to match against timezone name, code, country and other fields. Example: New_York.
sort_bystring- Property to sort by, optionally followed by asc or desc: id, modified, created, name, usage. Example: name asc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated descnamename ascname descusageusage ascusage desc
tave_user_getGet one studio user (team member) by ID.Read-onlyGet User
Get one studio user (team member) by ID. Returns the user with id, username, contactId, isAdmin and isBillingContact. Use tave_user_get for one user. Use tave_users_list to find IDs; read the user's name with tave_contact_get on contactId.
Inputs
idstringrequired- ULID of the user. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_users_listList the studio's users (team members).Read-onlyList Users
List the studio's users (team members). Returns users with id, name and email. Use tave_users_list to get user IDs for task assignment.
Inputs
pageinteger- Page of results, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
sort_bystring- Sort order: id, modified or created, optionally followed by asc or desc (default id). Example: created desc.one of
idid ascid descmodifiedmodified ascmodified desccreatedcreated asccreated desc
tave_brand_createCreate a brand: a business identity with its own name, emails, phones and theme for client-facing pages.WriteCreate Brand
Create a brand: a business identity with its own name, emails, phones and theme for client-facing pages. Returns the new brand with its id. Use tave_brand_create to add a second business line. Use tave_brand_update to change an existing brand.
Inputs
namestringrequired- Brand name, 4 to 128 characters. Example: Rivera Photography.
aliasstring- Short unique alias for the brand, 4 to 32 characters. Example: rivera.
bccstring- Email address that is BCC'd on emails sent under this brand. Example: archive@riveraphoto.com.
breakout_package_pricingboolean- true to show the price of each item inside a package. Example: false.
custom_domainstring- Custom domain for the brand's client portal, up to 128 characters. Example: clients.riveraphoto.com.
enable_profile_editboolean- true to let clients edit their profile in the client portal. Example: true.
forward_tostring- Email address that incoming brand email is forwarded to. Example: studio@riveraphoto.com.
google_analytics_idstring- Google Analytics tracking ID in the form UA-, YT- or MO- followed by two number groups. Example: UA-12345678-1.
location_idstring- ULID of a location entry in the address book (kind location, from tave_contacts_list) used as the brand's address. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
office_hoursstring- Office hours text shown to clients, up to 255 characters. Example: Mon-Fri 9am-5pm.
phone1_labelstring- Label for brand phone 1, 1 to 64 characters. Example: Office.
phone1_numberstring- Brand phone 1 number as free text, up to 24 characters. Example: (555) 010-1234.
phone2_labelstring- Label for brand phone 2, 1 to 64 characters. Example: Mobile.
phone2_numberstring- Brand phone 2 number as free text, up to 24 characters. Example: (555) 010-5678.
phone3_labelstring- Label for brand phone 3, 1 to 64 characters. Example: Fax.
phone3_numberstring- Brand phone 3 number as free text, up to 24 characters. Example: (555) 010-9012.
reply_tostring- Reply-to email address for emails sent under this brand. Example: hello@riveraphoto.com.
root_contact_form_idstring- ULID of the brand's main contact form. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
short_namestring- Shorter brand name for constrained places in the UI, 4 to 128 characters. Example: Rivera Photo.
show_history_in_portalboolean- true to show the job history in the client portal. Example: true.
theme_colorsobject- Theme colors as an object of lowercase 6-digit hex values without #; keys: accent, background, box, error, footerText, link, print, text. Example: {"accent": "c0392b", "background": "ffffff", "text": "222222"}.
tave_brand_updateUpdate a brand's name, emails, phones, portal settings or theme (PUT replaces the brand: read it with tave_brand_get first and resend fields you want to keep).WriteUpdate Brand
Update a brand's name, emails, phones, portal settings or theme (PUT replaces the brand: read it with tave_brand_get first and resend fields you want to keep). Returns the updated brand. Use tave_brand_update to change an existing brand. Use tave_brand_create for a new one.
- Idempotent
Inputs
idstringrequired- ULID of the brand. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
aliasstring- Short unique alias for the brand, 4 to 32 characters. Example: rivera.
bccstring- Email address that is BCC'd on emails sent under this brand. Example: archive@riveraphoto.com.
breakout_package_pricingboolean- true to show the price of each item inside a package. Example: false.
custom_domainstring- Custom domain for the brand's client portal, up to 128 characters. Example: clients.riveraphoto.com.
enable_profile_editboolean- true to let clients edit their profile in the client portal. Example: true.
forward_tostring- Email address that incoming brand email is forwarded to. Example: studio@riveraphoto.com.
google_analytics_idstring- Google Analytics tracking ID in the form UA-, YT- or MO- followed by two number groups. Example: UA-12345678-1.
location_idstring- ULID of a location entry in the address book (kind location, from tave_contacts_list) used as the brand's address. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestring- Brand name, 4 to 128 characters. Example: Rivera Photography.
office_hoursstring- Office hours text shown to clients, up to 255 characters. Example: Mon-Fri 9am-5pm.
phone1_labelstring- Label for brand phone 1, 1 to 64 characters. Example: Office.
phone1_numberstring- Brand phone 1 number as free text, up to 24 characters. Example: (555) 010-1234.
phone2_labelstring- Label for brand phone 2, 1 to 64 characters. Example: Mobile.
phone2_numberstring- Brand phone 2 number as free text, up to 24 characters. Example: (555) 010-5678.
phone3_labelstring- Label for brand phone 3, 1 to 64 characters. Example: Fax.
phone3_numberstring- Brand phone 3 number as free text, up to 24 characters. Example: (555) 010-9012.
reply_tostring- Reply-to email address for emails sent under this brand. Example: hello@riveraphoto.com.
root_contact_form_idstring- ULID of the brand's main contact form. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
short_namestring- Shorter brand name for constrained places in the UI, 4 to 128 characters. Example: Rivera Photo.
show_history_in_portalboolean- true to show the job history in the client portal. Example: true.
theme_colorsobject- Theme colors as an object of lowercase 6-digit hex values without #; keys: accent, background, box, error, footerText, link, print, text. Example: {"accent": "c0392b", "background": "ffffff", "text": "222222"}.
tave_contact_createCreate an address book entry: a person, company or location.WriteCreate Address Book Entry
Create an address book entry: a person, company or location. Returns the new contact with its id. Use tave_contact_create before adding the contact to a job with tave_job_contact_create.
Inputs
brand_idstring- ULID of the studio brand the contact belongs to. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
cell_phonestring- Mobile phone number (person or company). Example: +15125550101.
company_namestring- Company a person works for. Example: Rivera Events.
emailstring- Email address. Example: jamie@example.com.
first_namestring- First name of a person. Example: Jamie.
kindstring- Type of address book entry: person (default), company or location. Example: person.one of
personcompanylocation last_namestring- Last name of a person. Example: Rivera.
namestring- Name of a company or location (for a person it is built from first and last name). Example: Rivera Events.
notesstring- Notes about the contact. Example: Prefers email contact.
tave_contact_updateUpdate an address book entry (PUT replaces the entry: read it with tave_contact_get first and resend fields you want to keep).WriteUpdate Address Book Entry
Update an address book entry (PUT replaces the entry: read it with tave_contact_get first and resend fields you want to keep). Returns the updated contact. Use tave_contact_update to fix a name, email or phone.
- Idempotent
Inputs
idstringrequired- ULID of the address book entry. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
brand_idstring- ULID of the studio brand the contact belongs to. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
cell_phonestring- Mobile phone number (person or company). Example: +15125550101.
company_namestring- Company a person works for. Example: Rivera Events.
emailstring- Email address. Example: jamie@example.com.
first_namestring- First name of a person. Example: Jamie.
kindstring- Type of address book entry: person (default), company or location. Example: person.one of
personcompanylocation last_namestring- Last name of a person. Example: Rivera.
namestring- Name of a company or location (for a person it is built from first and last name). Example: Rivera Events.
notesstring- Notes about the contact. Example: Prefers email contact.
tave_contract_createCreate a contract on a job, from a template or with its own text.WriteCreate Contract
Create a contract on a job, from a template or with its own text. Returns the new contract with clientUrl. Use tave_contract_create after booking; the client signs it at clientUrl.
Inputs
job_idstringrequired- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
body_htmlstring- Contract text (HTML), when not using a template. Example: <p>This agreement is between...</p>.
contract_template_idstring- ULID of a contract template to copy. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
counter_signature_labelstring- Studio countersignature label. Example: Photographer.
namestring- Contract name. Example: Wedding photography agreement.
order_idstring- ULID of the order the contract covers. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
recipient_idstring- ULID of the contact who signs. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
signature_labelsstring- Client signature field labels, one per line. Example: Client 1 Client 2.
tave_custom_field_createCreate a custom field for jobs or contacts, such as a text box, date or drop-down.WriteCreate Custom Field
Create a custom field for jobs or contacts, such as a text box, date or drop-down. Returns the new custom field with its id. Use tave_custom_field_create to track extra details. Use tave_custom_field_update to change an existing field.
Inputs
namestringrequired- Custom field name shown to the studio, up to 255 characters. Example: Venue Coordinator.
can_apply_tostring- Record type the field applies to: Job (default) or Contact. Example: Job.one of
JobContact choicesarray- Options for a DropDown field. Example: ["Indoor", "Outdoor"].
client_accessstring- What clients can do with the field in the client portal: None (default), Visible or Editable. Example: Visible.one of
NoneVisibleEditable client_labelstring- Label shown to clients instead of the name, up to 255 characters. Example: Your venue coordinator.
kindstring- Field type: TextField (default), TextBox, DropDown, Number, Decimal, Money, Date, Time or Checkbox. Example: DropDown.one of
TextFieldTextBoxDropDownNumberDecimalMoneyDateTimeCheckbox tokenstring- Placeholder token used to insert the field's value in templates, up to 128 characters. Example: venue_coordinator.
tave_custom_field_updateUpdate a custom field definition (PUT replaces the field: read it with tave_custom_field_get first and resend fields you want to keep).WriteUpdate Custom Field
Update a custom field definition (PUT replaces the field: read it with tave_custom_field_get first and resend fields you want to keep). Returns the updated custom field. Use tave_custom_field_update to rename a field or change its choices or client access. Use tave_custom_field_create for a new field.
- Idempotent
Inputs
idstringrequired- ULID of the custom field. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
can_apply_tostring- Record type the field applies to: Job (default) or Contact. Example: Job.one of
JobContact choicesarray- Options for a DropDown field. Example: ["Indoor", "Outdoor"].
client_accessstring- What clients can do with the field in the client portal: None (default), Visible or Editable. Example: Visible.one of
NoneVisibleEditable client_labelstring- Label shown to clients instead of the name, up to 255 characters. Example: Your venue coordinator.
kindstring- Field type: TextField (default), TextBox, DropDown, Number, Decimal, Money, Date, Time or Checkbox. Example: DropDown.one of
TextFieldTextBoxDropDownNumberDecimalMoneyDateTimeCheckbox namestring- Custom field name shown to the studio, up to 255 characters. Example: Venue Coordinator.
tokenstring- Placeholder token used to insert the field's value in templates, up to 128 characters. Example: venue_coordinator.
tave_discount_createCreate a discount (a fixed amount or percentage) under a discount type.WriteCreate Discount
Create a discount (a fixed amount or percentage) under a discount type. Returns the new discount with its id. Use tave_discount_create to add a discount. Get type_id from tave_discount_types_list or create one with tave_discount_type_create.
Inputs
namestringrequired- Discount name, up to 128 characters. Example: Returning client.
priceintegerrequired- Discount value, a non-negative integer. For kind Amount, an amount in the studio's currency in minor units (for example 15000 for 150.00; compare with an existing record from tave_discounts_list if unsure); for kind Percent, the percentage. Example: 15000.
type_idstringrequired- ULID of the discount type (from tave_discount_types_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
description_htmlstring- Description (HTML). Example: <p>For past clients.</p>.
kindstring- How price is applied: Amount (fixed amount) or Percent. Example: Amount.one of
AmountPercent manual_entryboolean- true (default) to let the studio enter the amount when adding the discount. Example: true.
rebateboolean- true if the discount is a rebate (default false). Example: false.
skustring- Stock keeping unit, up to 48 characters. Example: DISC-RET.
tave_discount_type_createCreate a discount type, optionally nested under a parent type.WriteCreate Discount Type
Create a discount type, optionally nested under a parent type. Returns the new discount type with its id. Use tave_discount_type_create before tave_discount_create when no suitable type exists in tave_discount_types_list.
Inputs
namestringrequired- Discount type name, up to 255 characters. Example: Loyalty.
parent_idstring- ULID of a parent discount type, to nest this type under it. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_event_createCreate a calendar event, optionally on a job.WriteCreate Event
Create a calendar event, optionally on a job. Returns the new event. Use tave_event_create to schedule a session or consultation.
Inputs
all_dayboolean- true for an all-day event. Example: false.
channelstring- How the event happens. Example: InPerson.one of
InPersonPhoneVirtual confirmedboolean- true if the event is confirmed. Example: true.
description_htmlstring- Event description (HTML). Example: <p>Meet at the park entrance.</p>.
end_datestring- End date (YYYY-MM-DD). Example: 2027-03-20.
end_timestring- End time, 24-hour HH:MM. Example: 16:00.
job_idstring- ULID of the job the event belongs to. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
namestring- Event name. Example: Engagement session.
start_datestring- Start date (YYYY-MM-DD). Example: 2027-03-20.
start_timestring- Start time, 24-hour HH:MM. Example: 14:00.
timezone_namestring- Timezone name, for example America/Chicago. Example: America/Chicago.
type_idstring- ULID of the event type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
virtual_urlstring- Meeting link for a virtual event. Example: https://meet.example.com/abc.
tave_event_type_createCreate an event type for the calendar, with its kind, color, default duration and default attendees.WriteCreate Event Type
Create an event type for the calendar, with its kind, color, default duration and default attendees. Returns the new event type with its id. Use tave_event_type_create to add a new kind of session or meeting. Use tave_event_type_update to change an existing type.
Inputs
namestringrequired- Event type name, 1 to 24 characters. Example: Engagement Session.
token_prefixstringrequired- Unique placeholder prefix for this event type in templates: lowercase letters, digits and underscores, up to 32 characters. Reserved prefixes such as job, event, order, brand and client are not allowed. Example: engagement.
colorstring- Calendar color as a lowercase 6-digit hex value without #. Example: 2e86c1.
default_attendeesarray- Token prefixes of the job roles invited by default. Example: ["bride", "groom"].
default_durationinteger- Default event length in minutes, 5 to 86400 (default 60). Example: 90.
default_location_idstring- ULID of the default location (an address book entry of kind location, from tave_contacts_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
kindstring- Event kind: call, meeting (default), other or session. Example: session.one of
callmeetingothersession sort_positioninteger- Position in sorted lists, 0 to 65535 (default 100). Example: 100.
tave_event_type_updateUpdate an event type (PUT replaces the type: read it with tave_event_type_get first and resend fields you want to keep; name and token_prefix are always required).WriteUpdate Event Type
Update an event type (PUT replaces the type: read it with tave_event_type_get first and resend fields you want to keep; name and token_prefix are always required). Returns the updated event type. Use tave_event_type_update to rename a type or change its defaults. Use tave_event_type_create for a new type.
- Idempotent
Inputs
idstringrequired- ULID of the event type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestringrequired- Event type name, 1 to 24 characters. Example: Engagement Session.
token_prefixstringrequired- Unique placeholder prefix for this event type in templates: lowercase letters, digits and underscores, up to 32 characters. Reserved prefixes such as job, event, order, brand and client are not allowed. Example: engagement.
colorstring- Calendar color as a lowercase 6-digit hex value without #. Example: 2e86c1.
default_attendeesarray- Token prefixes of the job roles invited by default. Example: ["bride", "groom"].
default_durationinteger- Default event length in minutes, 5 to 86400 (default 60). Example: 90.
default_location_idstring- ULID of the default location (an address book entry of kind location, from tave_contacts_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
kindstring- Event kind: call, meeting (default), other or session. Example: session.one of
callmeetingothersession sort_positioninteger- Position in sorted lists, 0 to 65535 (default 100). Example: 100.
tave_event_updateUpdate an event (PUT replaces the event: read it with tave_event_get first and resend fields you want to keep).WriteUpdate Event
Update an event (PUT replaces the event: read it with tave_event_get first and resend fields you want to keep). Returns the updated event. Use tave_event_update to reschedule.
- Idempotent
Inputs
idstringrequired- ULID of the event. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
all_dayboolean- true for an all-day event. Example: false.
channelstring- How the event happens. Example: InPerson.one of
InPersonPhoneVirtual confirmedboolean- true if the event is confirmed. Example: true.
description_htmlstring- Event description (HTML). Example: <p>Meet at the park entrance.</p>.
end_datestring- End date (YYYY-MM-DD). Example: 2027-03-20.
end_timestring- End time, 24-hour HH:MM. Example: 16:00.
job_idstring- ULID of the job the event belongs to. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
namestring- Event name. Example: Engagement session.
start_datestring- Start date (YYYY-MM-DD). Example: 2027-03-20.
start_timestring- Start time, 24-hour HH:MM. Example: 14:00.
timezone_namestring- Timezone name, for example America/Chicago. Example: America/Chicago.
type_idstring- ULID of the event type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
virtual_urlstring- Meeting link for a virtual event. Example: https://meet.example.com/abc.
tave_file_createUpload a file from base64 content or a public URL and optionally attach it to a job, contact or other record.WriteCreate File
Upload a file from base64 content or a public URL and optionally attach it to a job, contact or other record. Returns the new file with its id and download URL. Use tave_file_create to add a file. Use tave_file_update to rename or re-attach an existing file and tave_gallery_create to link a client gallery. Provide binary_data or remote_url; pick a type_id from tave_file_types_list if needed.
Inputs
filenamestringrequired- File name including its extension. Example: contract-signed.pdf.
attached_toarray- Records the file is attached to. Each item has an entity (brand, contact, event, gallery, invoice, invoice-item, job, payment, product or product-option) and the record's ULID as id. Example: [{"entity": "job", "id": "01j8z3k4m5n6p7q8r9s0t1v2w3"}].
binary_datastring- Base64-encoded file content (max about 20 MB encoded). Provide either binary_data or remote_url so the file has content; one of the two is needed. Example: JVBERi0xLjQKJcfsj6IK.
created_by_contact_idstring- ULID of the address book contact who provided the file, if a client uploaded it. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
descriptionstring- Description of the file. Example: Countersigned wedding contract.
mime_typestring- MIME type of the file. Example: application/pdf.
namestring- Display name of the file. Example: Signed contract.
remote_urlstring- Public URL VSCO Workspace downloads the file from, instead of sending binary_data. Provide either remote_url or binary_data. Example: https://example.com/files/contract-signed.pdf.
type_idstring- ULID of the file type (from tave_file_types_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_file_updateUpdate a file's name, description, type, attachments or content (PUT replaces the file: read it with tave_file_get first and resend fields you want to keep).WriteUpdate File
Update a file's name, description, type, attachments or content (PUT replaces the file: read it with tave_file_get first and resend fields you want to keep). Returns the updated file. Use tave_file_update to change an existing file. Use tave_file_create to upload a new one and tave_file_delete to remove one.
- Idempotent
Inputs
filenamestringrequired- File name including its extension. Example: contract-signed.pdf.
idstringrequired- ULID of the file. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
attached_toarray- Records the file is attached to. Each item has an entity (brand, contact, event, gallery, invoice, invoice-item, job, payment, product or product-option) and the record's ULID as id. Example: [{"entity": "job", "id": "01j8z3k4m5n6p7q8r9s0t1v2w3"}].
binary_datastring- Base64-encoded file content (max about 20 MB encoded). Provide either binary_data or remote_url so the file has content; leave both empty to keep the current content. Example: JVBERi0xLjQKJcfsj6IK.
created_by_contact_idstring- ULID of the address book contact who provided the file, if a client uploaded it. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
descriptionstring- Description of the file. Example: Countersigned wedding contract.
mime_typestring- MIME type of the file. Example: application/pdf.
namestring- Display name of the file. Example: Signed contract.
remote_urlstring- Public URL VSCO Workspace downloads the file from, instead of sending binary_data. Leave empty to keep the current content. Example: https://example.com/files/contract-signed.pdf.
type_idstring- ULID of the file type (from tave_file_types_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_gallery_createLink a client photo gallery hosted in a gallery service to the studio, optionally on a job or event.WriteCreate Gallery
Link a client photo gallery hosted in a gallery service to the studio, optionally on a job or event. Returns the new gallery with its id. Use tave_gallery_create to record a new gallery. Use tave_gallery_update to change one and tave_galleries_list to find existing galleries.
Inputs
admin_urlstringrequired- URL of the gallery's admin page in the gallery service, for studio staff. Example: https://admin.galleries.example.com/g/1234.
client_urlstringrequired- Gallery URL for clients, used in emails and the client portal. Example: https://galleries.example.com/rivera-wedding.
namestringrequired- Name of the gallery. Example: Rivera Wedding Gallery.
categorystring- Category text used to group galleries. Example: Weddings.
cover_photo_focal_point_xnumber- Horizontal focal point of the cover photo, from 0 (left) to 1 (right). Used only with cover_photo_url. Example: 0.5.
cover_photo_focal_point_ynumber- Vertical focal point of the cover photo, from 0 (top) to 1 (bottom). Used only with cover_photo_url. Example: 0.4.
cover_photo_urlstring- Public URL of a cover photo to import (VSCO Workspace downsizes it below 2,000 pixels; avoid originals). Example: https://example.com/photos/cover.jpg.
event_datestring- Date of the event the gallery covers (YYYY-MM-DD). Example: 2027-06-12.
event_idstring- ULID of the event the gallery belongs to. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
expiration_datestring- Date the gallery stops being accessible (YYYY-MM-DD). Example: 2028-07-01.
headlinestring- Headline shown instead of the name when present. Example: Jamie & Alex - June 12, 2027.
job_idstring- ULID of the job the gallery belongs to. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
order_countinteger- Number of orders placed from the gallery. Example: 3.
order_due_datestring- Date orders for the gallery are due (YYYY-MM-DD). Example: 2027-08-01.
passwordstring- Reusable plain-text passcode that unlocks the gallery. Example: rivera2027.
photo_countinteger- Number of photos in the gallery. Example: 450.
publicboolean- true if the gallery is publicly accessible. Example: false.
release_datestring- Date the gallery is released (YYYY-MM-DD). Example: 2027-07-01.
remote_createdstring- When the gallery was created in the gallery service (ISO 8601 date-time, UTC). Example: 2027-06-20T18:00:00+00:00.
remote_idstring- ID of the gallery in the gallery service; must be unique for the studio. Example: gal_1234.
requires_passwordboolean- true if a passcode is needed to open the gallery (default true). Example: true.
slugstring- URL slug: letters, numbers, dashes and underscores; converted to lowercase. Example: rivera-wedding.
statusstring- Gallery status (default active). Example: active.one of
pre-releaseactiveinactivearchived visitor_countinteger- Number of visitors to the gallery. Example: 57.
tave_gallery_updateUpdate a client gallery (PUT replaces the gallery: read it with tave_gallery_get first and resend fields you want to keep).WriteUpdate Gallery
Update a client gallery (PUT replaces the gallery: read it with tave_gallery_get first and resend fields you want to keep). Returns the updated gallery. Use tave_gallery_update to change status, dates, URLs or counts. Use tave_gallery_create for a new gallery and tave_gallery_delete to remove one.
- Idempotent
Inputs
admin_urlstringrequired- URL of the gallery's admin page in the gallery service, for studio staff. Example: https://admin.galleries.example.com/g/1234.
client_urlstringrequired- Gallery URL for clients, used in emails and the client portal. Example: https://galleries.example.com/rivera-wedding.
idstringrequired- ULID of the gallery. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestringrequired- Name of the gallery. Example: Rivera Wedding Gallery.
categorystring- Category text used to group galleries. Example: Weddings.
cover_photo_focal_point_xnumber- Horizontal focal point of the cover photo, from 0 (left) to 1 (right). Used only with cover_photo_url. Example: 0.5.
cover_photo_focal_point_ynumber- Vertical focal point of the cover photo, from 0 (top) to 1 (bottom). Used only with cover_photo_url. Example: 0.4.
cover_photo_urlstring- Public URL of a cover photo to import (VSCO Workspace downsizes it below 2,000 pixels; avoid originals). Example: https://example.com/photos/cover.jpg.
event_datestring- Date of the event the gallery covers (YYYY-MM-DD). Example: 2027-06-12.
event_idstring- ULID of the event the gallery belongs to. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
expiration_datestring- Date the gallery stops being accessible (YYYY-MM-DD). Example: 2028-07-01.
headlinestring- Headline shown instead of the name when present. Example: Jamie & Alex - June 12, 2027.
job_idstring- ULID of the job the gallery belongs to. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
order_countinteger- Number of orders placed from the gallery. Example: 3.
order_due_datestring- Date orders for the gallery are due (YYYY-MM-DD). Example: 2027-08-01.
passwordstring- Reusable plain-text passcode that unlocks the gallery. Example: rivera2027.
photo_countinteger- Number of photos in the gallery. Example: 450.
publicboolean- true if the gallery is publicly accessible. Example: false.
release_datestring- Date the gallery is released (YYYY-MM-DD). Example: 2027-07-01.
remote_createdstring- When the gallery was created in the gallery service (ISO 8601 date-time, UTC). Example: 2027-06-20T18:00:00+00:00.
remote_idstring- ID of the gallery in the gallery service; must be unique for the studio. Example: gal_1234.
requires_passwordboolean- true if a passcode is needed to open the gallery (default true). Example: true.
slugstring- URL slug: letters, numbers, dashes and underscores; converted to lowercase. Example: rivera-wedding.
statusstring- Gallery status (default active). Example: active.one of
pre-releaseactiveinactivearchived visitor_countinteger- Number of visitors to the gallery. Example: 57.
tave_job_closed_reason_createCreate a job closed reason.WriteCreate Job Closed Reason
Create a job closed reason. Returns the new closed reason with its id. Use tave_job_closed_reason_create to add a reason. Use tave_job_closed_reason_update or tave_job_closed_reason_partial_update to change one.
Inputs
namestringrequired- Name of the closed reason (1 to 32 characters). Example: Went with another studio.
descriptionstring- Longer description (up to 64 characters). Example: Client booked a different photographer.
included_in_reportingboolean- true to count jobs closed with this reason in reports. Example: true.
tave_job_closed_reason_partial_updateChange only the given fields of a job closed reason (PATCH: fields you leave out keep their values; send at least one).WritePartially Update Job Closed Reason
Change only the given fields of a job closed reason (PATCH: fields you leave out keep their values; send at least one). Returns the updated closed reason. Use tave_job_closed_reason_partial_update for small edits. Use tave_job_closed_reason_update to replace the whole reason.
- Idempotent
Inputs
idstringrequired- ULID of the job closed reason. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
descriptionstring- Longer description (up to 64 characters). Example: Client booked a different photographer.
included_in_reportingboolean- true to count jobs closed with this reason in reports. Example: true.
namestring- Name of the closed reason (1 to 32 characters). Example: Went with another studio.
tave_job_closed_reason_updateReplace a job closed reason (PUT: name is required and fields you leave out are cleared; read it with tave_job_closed_reason_get first).WriteUpdate Job Closed Reason
Replace a job closed reason (PUT: name is required and fields you leave out are cleared; read it with tave_job_closed_reason_get first). Returns the updated closed reason. Use tave_job_closed_reason_update to rewrite the whole reason. Use tave_job_closed_reason_partial_update to change only some fields.
- Idempotent
Inputs
idstringrequired- ULID of the job closed reason. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestringrequired- Name of the closed reason (1 to 32 characters). Example: Went with another studio.
descriptionstring- Longer description (up to 64 characters). Example: Client booked a different photographer.
included_in_reportingboolean- true to count jobs closed with this reason in reports. Example: true.
tave_job_contact_createLink an address book contact to a job, optionally as a client and with roles.WriteAdd Contact to Job
Link an address book contact to a job, optionally as a client and with roles. Returns the job contact. Use tave_job_contact_create after tave_contact_create and tave_job_create.
Inputs
contact_idstringrequired- ULID of the address book contact. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
job_idstringrequired- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
clientboolean- true if the contact is a client on the job. Example: true.
job_rolesarray- ULIDs of job roles (from the studio's job roles). Example: ["01j8z3k4m5n6p7q8r9s0t1v2y5"].
tave_job_contact_updateUpdate how a contact is linked to a job: client flag and job roles (PUT replaces the job contact: read it with tave_job_contact_get first and resend fields you want to keep).WriteUpdate Job Contact
Update how a contact is linked to a job: client flag and job roles (PUT replaces the job contact: read it with tave_job_contact_get first and resend fields you want to keep). Returns the updated job contact. Use tave_job_contact_update to change roles or client status. Use tave_job_contact_create to add a contact to a job and tave_job_contact_delete to remove one.
- Idempotent
Inputs
contact_idstringrequired- ULID of the address book contact. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
idstringrequired- ULID of the job contact. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
job_idstringrequired- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
clientboolean- true if the contact is a client on the job. Example: true.
job_rolesarray- ULIDs of job roles (from tave_job_roles_list). Example: ["01j8z3k4m5n6p7q8r9s0t1v2y5"].
tave_job_createCreate a job or lead.WriteCreate Job
Create a job or lead. Returns the new job with its id. Use tave_job_create for a new inquiry, then link the client with tave_job_contact_create.
Inputs
booking_datestring- Booking date (YYYY-MM-DD). Example: 2026-12-01.
brand_idstring- ULID of the studio brand. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
closedboolean- true to close the lead or job. Example: false.
closed_reason_idstring- ULID of the job closed reason, when closing. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
event_datestring- Main event date (YYYY-MM-DD). Example: 2027-06-12.
guest_countinteger- Number of guests. Example: 120.
inquiry_datestring- Inquiry date (YYYY-MM-DD). Example: 2026-11-16.
job_type_idstring- ULID of the job type (from tave_job_types_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
lead_confidencestring- How likely the lead is to book. Example: high.one of
lowmediumhigh lead_max_budgetinteger- Lead's maximum budget. Integer amount in the studio's currency, in minor units (for example 15000 for 150.00); compare with an existing record from tave_payments_list if unsure. Example: 500000.
lead_notesstring- Notes about the lead. Example: Found us on Instagram.
lead_source_idstring- ULID of the lead source (from tave_lead_sources_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
lead_status_idstring- ULID of the lead status (from tave_lead_statuses_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestring- Job name; overrides the generated title. Example: Rivera Wedding.
pinnedboolean- true to pin the job. Example: false.
stagestring- Job stage. Example: lead.one of
leadbookedfulfillmentcompleted
tave_job_order_createCreate an order (booked package or invoice of line items) on a job.WriteCreate Job Order
Create an order (booked package or invoice of line items) on a job. Returns the new order with its id, status, line items, taxes, totals and balance. Use tave_job_order_create to bill a job directly. Use tave_quote_create to offer priced options first, tave_order_update to change an order and tave_job_orders_list to see a job's orders.
Inputs
job_idstringrequired- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
due_datestring- Due date (YYYY-MM-DD); when set, a single invoice for the whole order is created with this due date. Example: 2027-01-15.
line_itemsarray- Line items on the order. Each needs a name and can set productId (from tave_products_list), descriptionHtml, units, pricePerUnit and costPerUnit (integer minor units of the studio currency), taxable, and discount with discountKind (amount or percent) for a discount line. Example: [{"productId": "01j8z3k4m5n6p7q8r9s0t1v2y5", "name": "Full day coverage", "units": 1, "pricePerUnit": 350000, "taxable": true}].
namestring- Order name; overrides the generated title. Example: Wedding collection.
payment_terms_idstring- ULID of the payment terms (payment schedule) to use. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
recipient_idstring- ULID of the address book contact the order is billed to. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
tax_group_idstring- ULID of the tax group to apply (from tave_tax_groups_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_job_role_createCreate a job role that contacts can hold on a job.WriteCreate Job Role
Create a job role that contacts can hold on a job. Returns the new job role with its id. Use tave_job_role_create to add a role. Use tave_job_role_update to change one and tave_job_roles_list to check existing roles first.
Inputs
namestringrequired- Name of the job role (1 to 24 characters). Example: Bride.
token_prefixstringrequired- Prefix for this role's email placeholders: 1 to 32 lowercase letters, digits or underscores, unique across job roles. Reserved: booked_order, brand, clients, contract, custom, customers, event, invoice, item, job, quote, order, payment, payment_schedule, primary_session, recipient, subjects, tave, team, vendors. Example: bride.
kindstring- What the role represents: customer, subject (default), team or vendor. Example: subject.one of
customersubjectteamvendor sort_positioninteger- Sort position, 0 to 65535 (default 100). Example: 100.
tave_job_role_updateUpdate a job role (PUT replaces the job role: read it with tave_job_role_get first and resend fields you want to keep).WriteUpdate Job Role
Update a job role (PUT replaces the job role: read it with tave_job_role_get first and resend fields you want to keep). Returns the updated job role. Use tave_job_role_update to rename or reorder a role. Use tave_job_role_create for a new role and tave_job_role_delete to remove one.
- Idempotent
Inputs
idstringrequired- ULID of the job role. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestringrequired- Name of the job role (1 to 24 characters). Example: Bride.
token_prefixstringrequired- Prefix for this role's email placeholders: 1 to 32 lowercase letters, digits or underscores, unique across job roles. Reserved: booked_order, brand, clients, contract, custom, customers, event, invoice, item, job, quote, order, payment, payment_schedule, primary_session, recipient, subjects, tave, team, vendors. Example: bride.
kindstring- What the role represents: customer, subject (default), team or vendor. Example: subject.one of
customersubjectteamvendor sort_positioninteger- Sort position, 0 to 65535 (default 100). Example: 100.
tave_job_type_createCreate a job type, optionally with the contact roles and events new jobs of that type start with.WriteCreate Job Type
Create a job type, optionally with the contact roles and events new jobs of that type start with. Returns the new job type with its id. Use tave_job_type_create to add a type. Use tave_job_type_update to change one and tave_job_types_list to check existing types first.
Inputs
namestringrequired- Name of the job type (1 to 128 characters). Example: Wedding.
default_contactsarray- Contact slots added to new jobs of this type. Each item names a job role (jobRoleId, from tave_job_roles_list) and can set whether it is a client, how many slots (quantity, default 1) and a sort position. Example: [{"jobRoleId": "01j8z3k4m5n6p7q8r9s0t1v2y5", "client": true, "quantity": 2}].
default_eventsarray- Events added to new jobs of this type. Each item names an event type (eventTypeId, from tave_event_types_list) and can set whether it is the primary session, how many (quantity, default 1) and a sort position. Example: [{"eventTypeId": "01j8z3k4m5n6p7q8r9s0t1v2y5", "primarySession": true, "quantity": 1}].
initial_lead_status_idstring- ULID of the lead status new leads of this type start in (from tave_lead_statuses_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
primary_session_requiredboolean- true if jobs of this type need a primary session (default true). Example: true.
profit_center_idstring- ULID of the profit center for this job type (from tave_profit_centers_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
sort_positioninteger- Sort position, 0 to 65535 (default 100). Example: 100.
workflow_idstring- ULID of the workflow new jobs of this type use. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_job_type_updateUpdate a job type (PUT replaces the job type: read it with tave_job_type_get first and resend fields you want to keep).WriteUpdate Job Type
Update a job type (PUT replaces the job type: read it with tave_job_type_get first and resend fields you want to keep). Returns the updated job type. Use tave_job_type_update to rename a type or change its defaults. Use tave_job_type_create for a new type and tave_job_type_delete to remove one.
- Idempotent
Inputs
idstringrequired- ULID of the job type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestringrequired- Name of the job type (1 to 128 characters). Example: Wedding.
default_contactsarray- Contact slots added to new jobs of this type. Each item names a job role (jobRoleId, from tave_job_roles_list) and can set whether it is a client, how many slots (quantity, default 1) and a sort position. Example: [{"jobRoleId": "01j8z3k4m5n6p7q8r9s0t1v2y5", "client": true, "quantity": 2}].
default_eventsarray- Events added to new jobs of this type. Each item names an event type (eventTypeId, from tave_event_types_list) and can set whether it is the primary session, how many (quantity, default 1) and a sort position. Example: [{"eventTypeId": "01j8z3k4m5n6p7q8r9s0t1v2y5", "primarySession": true, "quantity": 1}].
initial_lead_status_idstring- ULID of the lead status new leads of this type start in (from tave_lead_statuses_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
primary_session_requiredboolean- true if jobs of this type need a primary session (default true). Example: true.
profit_center_idstring- ULID of the profit center for this job type (from tave_profit_centers_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
sort_positioninteger- Sort position, 0 to 65535 (default 100). Example: 100.
workflow_idstring- ULID of the workflow new jobs of this type use. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_job_updateUpdate a job (PUT replaces the job: read it with tave_job_get first and resend fields you want to keep).WriteUpdate Job
Update a job (PUT replaces the job: read it with tave_job_get first and resend fields you want to keep). Returns the updated job. Use tave_job_update to change stage, dates, lead status or close a job.
- Idempotent
Inputs
idstringrequired- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
booking_datestring- Booking date (YYYY-MM-DD). Example: 2026-12-01.
brand_idstring- ULID of the studio brand. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
closedboolean- true to close the lead or job. Example: false.
closed_reason_idstring- ULID of the job closed reason, when closing. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
event_datestring- Main event date (YYYY-MM-DD). Example: 2027-06-12.
guest_countinteger- Number of guests. Example: 120.
inquiry_datestring- Inquiry date (YYYY-MM-DD). Example: 2026-11-16.
job_type_idstring- ULID of the job type (from tave_job_types_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
lead_confidencestring- How likely the lead is to book. Example: high.one of
lowmediumhigh lead_max_budgetinteger- Lead's maximum budget. Integer amount in the studio's currency, in minor units (for example 15000 for 150.00); compare with an existing record from tave_payments_list if unsure. Example: 500000.
lead_notesstring- Notes about the lead. Example: Found us on Instagram.
lead_source_idstring- ULID of the lead source (from tave_lead_sources_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
lead_status_idstring- ULID of the lead status (from tave_lead_statuses_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestring- Job name; overrides the generated title. Example: Rivera Wedding.
pinnedboolean- true to pin the job. Example: false.
stagestring- Job stage. Example: lead.one of
leadbookedfulfillmentcompleted
tave_job_worksheet_createCreate a job together with its contacts and events in one request; if any part fails, nothing is created.WriteCreate Job From Worksheet
Create a job together with its contacts and events in one request; if any part fails, nothing is created. Returns the new job worksheet: the job with its id plus the created contacts and events. Use tave_job_worksheet_create to book a new inquiry with its people and dates at once. Use tave_job_create for a bare job, then tave_job_contact_create and tave_event_create to add to it; use tave_job_worksheet_get to read a worksheet.
Inputs
booking_datestring- Booking date (YYYY-MM-DD). Example: 2026-12-01.
brand_idstring- ULID of the studio brand (from tave_brands_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
contactsarray- Contacts to add to the job. Each item needs a contact object with the address book details to create: kind (person, company or location) plus fields such as firstName, lastName, name and email. It can also set client (true for the paying client), jobRoles (job role ULIDs from tave_job_roles_list), attendingAllEvents and attendingAllSessions. Phone numbers inside contact are objects such as {"formatted": "+15125550101"}. Example: [{"client": true, "jobRoles": ["01j8z3k4m5n6p7q8r9s0t1v2y5"], "contact": {"kind": "person", "firstName": "Jamie", "lastName": "Rivera", "email": "jamie@example.com"}}].
custom_fieldsarray- Custom field values for the job. Each item has the custom field's ULID as fieldId (from tave_custom_fields_list) and a text value. Example: [{"fieldId": "01j8z3k4m5n6p7q8r9s0t1v2y5", "value": "Outdoor ceremony"}].
event_datestring- Main event date (YYYY-MM-DD). Example: 2027-06-12.
eventsarray- Events to create on the job. Each item can set name, typeId (from tave_event_types_list), startDate and endDate (YYYY-MM-DD), startTime and endTime (24-hour HH:MM), allDay, timezoneName, channel (InPerson, Phone or Virtual), virtualUrl, confirmed and descriptionHtml. Example: [{"name": "Wedding day", "typeId": "01j8z3k4m5n6p7q8r9s0t1v2y5", "startDate": "2027-06-12", "startTime": "14:00", "endDate": "2027-06-12", "endTime": "22:00"}].
guest_countinteger- Number of guests. Example: 120.
inquiry_datestring- Inquiry date (YYYY-MM-DD). Example: 2026-11-16.
job_type_idstring- ULID of the job type (from tave_job_types_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
lead_confidencestring- How likely the lead is to book. Example: high.one of
lowmediumhigh lead_decision_expected_by_datestring- Date the lead expects to decide (YYYY-MM-DD). Example: 2026-12-15.
lead_max_budgetinteger- Lead's maximum budget. Integer amount in the studio's currency, in minor units (for example 15000 for 150.00); compare with an existing record from tave_payments_list if unsure. Example: 500000.
lead_notesstring- Notes about the lead. Example: Found us on Instagram.
lead_ratinginteger- Lead rating from 1 to 5. Example: 4.
lead_source_idstring- ULID of the lead source (from tave_lead_sources_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
lead_status_idstring- ULID of the lead status (from tave_lead_statuses_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestring- Job name; overrides the generated title. Example: Rivera Wedding.
pinnedboolean- true to pin the job. Example: false.
stagestring- Job stage. Example: lead.one of
leadbookedfulfillmentcompleted web_leadboolean- true if the lead came from a contact form. Example: false.
workflow_idstring- ULID of the workflow to run on the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_lead_source_createCreate a lead source, the referral channel a lead came from.WriteCreate Lead Source
Create a lead source, the referral channel a lead came from. Returns the new lead source with id, name and parent ID. Use tave_lead_source_create to add a channel. Use tave_lead_sources_list to find an existing one and tave_lead_source_update to rename one.
Inputs
namestringrequired- Lead source name, 3 to 128 characters. Example: Instagram.
parent_idstring- ULID of the parent lead source, to nest this source under another one (from tave_lead_sources_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_lead_source_updateUpdate a lead source (PUT replaces the source: read it with tave_lead_source_get first and resend parent_id to keep it).WriteUpdate Lead Source
Update a lead source (PUT replaces the source: read it with tave_lead_source_get first and resend parent_id to keep it). Returns the updated lead source. Use tave_lead_source_update to rename or re-nest a source. Use tave_lead_source_create for a new one.
- Idempotent
Inputs
idstringrequired- ULID of the lead source. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestringrequired- Lead source name, 3 to 128 characters. Example: Instagram.
parent_idstring- ULID of the parent lead source, to nest this source under another one (from tave_lead_sources_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_lead_status_createCreate a lead status, a pipeline stage for leads, with optional automatic transitions.WriteCreate Lead Status
Create a lead status, a pipeline stage for leads, with optional automatic transitions. Returns the new lead status. Use tave_lead_status_create to add a stage. Use tave_lead_statuses_list to find existing ones and tave_job_update to set a lead's status.
Inputs
namestringrequired- Lead status name, 1 to 64 characters. Example: Consultation booked.
after_document_sent_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after a document is sent. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
after_email_sent_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after an email is sent. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
after_event_scheduled_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after an event is scheduled. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
after_form_sent_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after a form is sent. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
after_quote_sent_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after a quote is sent. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
colorstring- Display color as 6 lowercase hex digits, without #. Example: 3b82f6.
external_mappingsarray- Links from this status to records in an external system; each item has id (1 to 64 characters) and url (12 to 255 characters). Mappings cannot be changed after creation. Example: [{"id": "crm-4821", "url": "https://crm.example.com/statuses/4821"}].
kindstring- Status kind: general, new (given to new leads) or stale (given to leads that go quiet). Example: general.one of
generalnewstale sort_positioninteger- Position in the status list, 0 to 65535; lower comes first. Defaults to 100. Example: 100.
transition_closed_reason_idstring- ULID of the job closed reason (from tave_job_closed_reasons_list) to close the lead with when the automatic transition runs. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
transition_intervalinteger- Number of transition_interval_unit units a lead stays in this status before it moves to transition_to_id. Example: 14.
transition_interval_unitstring- Unit of transition_interval: day, week, month or year. Example: day.one of
dayweekmonthyear transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to automatically after the transition interval. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_lead_status_partial_updateChange some fields of a lead status (PATCH: only the fields you send change; send at least one).WritePartially Update Lead Status
Change some fields of a lead status (PATCH: only the fields you send change; send at least one). Returns the updated lead status. Use tave_lead_status_partial_update to rename, recolor or reorder a status. Use tave_lead_status_update to replace the whole status.
- Idempotent
Inputs
idstringrequired- ULID of the lead status. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
after_document_sent_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after a document is sent. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
after_email_sent_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after an email is sent. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
after_event_scheduled_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after an event is scheduled. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
after_form_sent_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after a form is sent. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
after_quote_sent_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after a quote is sent. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
colorstring- Display color as 6 lowercase hex digits, without #. Example: 3b82f6.
kindstring- Status kind: general, new (given to new leads) or stale (given to leads that go quiet). Example: general.one of
generalnewstale namestring- Lead status name, 1 to 64 characters. Example: Consultation booked.
sort_positioninteger- Position in the status list, 0 to 65535; lower comes first. Defaults to 100. Example: 100.
transition_closed_reason_idstring- ULID of the job closed reason (from tave_job_closed_reasons_list) to close the lead with when the automatic transition runs. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
transition_intervalinteger- Number of transition_interval_unit units a lead stays in this status before it moves to transition_to_id. Example: 14.
transition_interval_unitstring- Unit of transition_interval: day, week, month or year. Example: day.one of
dayweekmonthyear transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to automatically after the transition interval. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_lead_status_updateUpdate a lead status (PUT replaces the status: read it with tave_lead_status_get first and resend fields you want to keep).WriteUpdate Lead Status
Update a lead status (PUT replaces the status: read it with tave_lead_status_get first and resend fields you want to keep). Returns the updated lead status. Use tave_lead_status_update to rewrite the whole status. Use tave_lead_status_partial_update to change only the fields you send.
- Idempotent
Inputs
idstringrequired- ULID of the lead status. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestringrequired- Lead status name, 1 to 64 characters. Example: Consultation booked.
after_document_sent_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after a document is sent. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
after_email_sent_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after an email is sent. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
after_event_scheduled_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after an event is scheduled. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
after_form_sent_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after a form is sent. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
after_quote_sent_transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to after a quote is sent. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
colorstring- Display color as 6 lowercase hex digits, without #. Example: 3b82f6.
kindstring- Status kind: general, new (given to new leads) or stale (given to leads that go quiet). Example: general.one of
generalnewstale sort_positioninteger- Position in the status list, 0 to 65535; lower comes first. Defaults to 100. Example: 100.
transition_closed_reason_idstring- ULID of the job closed reason (from tave_job_closed_reasons_list) to close the lead with when the automatic transition runs. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
transition_intervalinteger- Number of transition_interval_unit units a lead stays in this status before it moves to transition_to_id. Example: 14.
transition_interval_unitstring- Unit of transition_interval: day, week, month or year. Example: day.one of
dayweekmonthyear transition_to_idstring- ULID of the lead status (from tave_lead_statuses_list) to move the lead to automatically after the transition interval. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_note_createAdd a note to a job or contact.WriteCreate Note
Add a note to a job or contact. Returns the new note. Use tave_note_create to log a call or decision.
Inputs
content_htmlstringrequired- Note text (HTML). Example: <p>Called the client; they want a second shooter.</p>.
contact_idstring- ULID of the contact. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
datestring- Note date (YYYY-MM-DD). Defaults to today. Example: 2026-11-16.
job_idstring- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
tave_note_updateUpdate a note's text or date.WriteUpdate Note
Update a note's text or date. Returns the updated note. Use tave_note_update to correct a note.
- Idempotent
Inputs
content_htmlstringrequired- Note text (HTML); replaces the existing text. Example: <p>Updated: two shooters confirmed.</p>.
idstringrequired- ULID of the note. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
datestring- Note date (YYYY-MM-DD). Example: 2026-11-16.
tave_order_updateUpdate an order's line items, recipient, tax group, payment terms or name (PUT replaces the order: read it with tave_order_get first and resend fields you want to keep).WriteUpdate Order
Update an order's line items, recipient, tax group, payment terms or name (PUT replaces the order: read it with tave_order_get first and resend fields you want to keep). Returns the updated order with recomputed totals, taxes and balance. Use tave_order_update to change what a client is buying. Use tave_order_void to cancel an order and tave_job_order_create for a new one.
- Idempotent
Inputs
idstringrequired- ULID of the order. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
due_datestring- Due date (YYYY-MM-DD); creates a single invoice for the order with this due date. Example: 2027-01-15.
line_itemsarray- The complete set of line items; it replaces the order's existing items, so resend every item you want to keep (read them with tave_order_get). Each item needs name and can have productId, descriptionHtml, units, pricePerUnit, costPerUnit, taxable, discount, discountKind, selectability and selected. pricePerUnit and costPerUnit: Integer amount in the studio's currency, in minor units (for example 15000 for 150.00); compare with an existing record from tave_payments_list if unsure. Example: [{"productId": "01j8z3k4m5n6p7q8r9s0t1v2y5", "name": "Full day coverage", "units": 1, "pricePerUnit": 350000, "taxable": true}].
namestring- Order name; overrides the generated title. Example: Wedding collection.
payment_terms_idstring- ULID of the payment terms. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
recipient_idstring- ULID of the bill-to contact. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
tax_group_idstring- ULID of the tax group (from tave_tax_groups_list); taxes are recomputed from it. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_payment_applyAllocate part or all of a payment to an order.WriteApply Payment to Order
Allocate part or all of a payment to an order. Returns the payment with its allocations. Use tave_payment_apply after tave_payment_create.
Inputs
amountintegerrequired- Amount to apply. Integer amount in the studio's currency, in minor units (for example 15000 for 150.00); compare with an existing record from tave_payments_list if unsure. Example: 15000.
idstringrequired- ULID of the payment. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
order_idstringrequired- ULID of the order to apply the payment to. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_payment_createRecord a payment received (or scheduled) on a job.WriteRecord Payment
Record a payment received (or scheduled) on a job. Returns the new payment. Use tave_payment_create for checks, cash or transfers received outside VSCO Workspace, then tave_payment_apply to allocate it.
Inputs
amountintegerrequired- Payment amount. Integer amount in the studio's currency, in minor units (for example 15000 for 150.00); compare with an existing record from tave_payments_list if unsure. Example: 15000.
job_idstringrequired- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
check_numberstring- Check number. Example: 1042.
memostring- Memo. Example: Deposit.
payer_idstring- ULID of the contact who paid. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
payment_method_idstring- ULID of the payment method (from tave_payment_methods_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
receivedstring- Date received (YYYY-MM-DD). Example: 2026-11-16.
statusstring- Payment status. Defaults to posted. Example: posted.one of
futureconfirmed-futurepostedfailedpending
tave_payment_updateUpdate a payment's status, date, payer, method, memo or check number; the amount cannot be changed (PUT replaces the payment: read it with tave_payment_get first and resend fields you want to keep).WriteUpdate Payment
Update a payment's status, date, payer, method, memo or check number; the amount cannot be changed (PUT replaces the payment: read it with tave_payment_get first and resend fields you want to keep). Returns the updated payment. Use tave_payment_update to correct payment details. To change the amount, delete it with tave_payment_delete and record it again with tave_payment_create; use tave_payment_apply to allocate it to an order.
- Idempotent
Inputs
idstringrequired- ULID of the payment. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
job_idstringrequired- ULID of the job the payment belongs to; resend the current value from tave_payment_get to keep it. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
auth_codestring- Processor authorization code, up to 100 characters; resend it to keep it. Example: A1B2C3.
check_numberstring- Check number, up to 18 characters. Example: 1042.
invoice_item_idstring- ULID of the invoice installment this payment is for. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
memostring- Memo, up to 128 characters. Example: Deposit.
payer_idstring- ULID of the contact who paid. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
payment_method_idstring- ULID of the payment method (from tave_payment_methods_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
receivedstring- Date received (YYYY-MM-DD). Example: 2026-11-16.
statusstring- Payment status. Example: posted.one of
futureconfirmed-futurepostedfailedpending transaction_idstring- Processor transaction ID, up to 255 characters; resend it to keep it. Example: ch_3Q1x2y3z4a5b6c7d.
tave_product_createCreate a product or service.WriteCreate Product
Create a product or service. Returns the new product. Use tave_product_create to add something you sell.
Inputs
namestringrequired- Product name. Example: Second shooter (per hour)
deliverableboolean- true if the product is a deliverable. Example: false.
description_htmlstring- Description (HTML). Example: <p>Additional photographer.</p>.
priceinteger- Price. Integer amount in the studio's currency, in minor units (for example 15000 for 150.00); compare with an existing record from tave_payments_list if unsure. Example: 15000.
skustring- Stock keeping unit. Example: SS-HR.
taxableboolean- true if tax applies. Example: true.
typestring- ULID of the product type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_product_partial_updateChange some fields of a product, such as its price or name (PATCH: only the fields you send change; send at least one).WritePartially Update Product
Change some fields of a product, such as its price or name (PATCH: only the fields you send change; send at least one). Returns the updated product. Use tave_product_partial_update for a quick change like a new price. Use tave_product_update to replace the whole product (PUT) and tave_product_get to read it first.
- Idempotent
Inputs
idstringrequired- ULID of the product. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
deliverableboolean- true if the product is a deliverable. Example: false.
description_htmlstring- Description (HTML). Example: <p>Additional photographer.</p>.
expense_category_idstring- ULID of the expense category for the product's costs. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
expense_due_fromstring- When the product's expenses fall due from: JobDate, Booking or Never. Example: Booking.one of
JobDateBookingNever expense_due_periodnumber- Number of expense_due_period_type units after expense_due_from that expenses fall due. Example: 30.
expense_due_period_typestring- Unit of expense_due_period: Days, Weeks or Months. Example: Days.one of
DaysWeeksMonths expensesarray- Product expenses (costs), each with memo and amount. amount: Integer amount in the studio's currency, in minor units (for example 15000 for 150.00); compare with an existing record from tave_payments_list if unsure. Example: [{"memo": "Album printing", "amount": 12000}].
manual_entryboolean- true if the product is entered manually rather than from the catalog. Example: false.
namestring- Product name, up to 128 characters. Example: Second shooter (per hour).
priceinteger- Price. Integer amount in the studio's currency, in minor units (for example 15000 for 150.00); compare with an existing record from tave_payments_list if unsure. Example: 15000.
skustring- Stock keeping unit, up to 48 characters. Example: SS-HR.
taxableboolean- true if tax applies. Example: true.
typestring- ULID of the product type (from tave_product_types_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
vendor_idstring- ULID of the vendor contact who supplies the product. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
tave_product_type_createCreate a product type, a category for products.WriteCreate Product Type
Create a product type, a category for products. Returns the new product type. Use tave_product_type_create to add a category. Use tave_product_types_list to find an existing one.
Inputs
namestringrequired- Product type name, up to 255 characters. Example: Fine art prints.
kindstring- Product type kind. Defaults to Other. Example: Print.one of
SessionAlbumPrintOtherService parent_idstring- ULID of the parent product type, to nest this type under another one. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_product_updateUpdate a product (PUT replaces the product: read it with tave_product_get first and resend fields you want to keep).WriteUpdate Product
Update a product (PUT replaces the product: read it with tave_product_get first and resend fields you want to keep). Returns the updated product. Use tave_product_update to rewrite a product. Use tave_product_partial_update to change only some fields, such as a price.
- Idempotent
Inputs
idstringrequired- ULID of the product. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
deliverableboolean- true if the product is a deliverable. Example: false.
description_htmlstring- Description (HTML). Example: <p>Additional photographer.</p>.
namestring- Product name. Example: Second shooter (per hour)
priceinteger- Price. Integer amount in the studio's currency, in minor units (for example 15000 for 150.00); compare with an existing record from tave_payments_list if unsure. Example: 15000.
skustring- Stock keeping unit. Example: SS-HR.
taxableboolean- true if tax applies. Example: true.
typestring- ULID of the product type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_profit_center_createCreate a profit center, a revenue category for reporting product sales.WriteCreate Profit Center
Create a profit center, a revenue category for reporting product sales. Returns the new profit center with its id. Use tave_profit_center_create to add a category. Use tave_profit_centers_list first to avoid duplicates.
Inputs
namestringrequired- Profit center name, up to 24 characters. Example: Prints.
tave_profit_center_partial_updateChange only the fields you send on a profit center (PATCH); omitted fields keep their values.WritePartially Update Profit Center
Change only the fields you send on a profit center (PATCH); omitted fields keep their values. Returns the updated profit center. Use tave_profit_center_partial_update for a targeted change. Use tave_profit_center_update (PUT) to replace the whole record.
- Idempotent
Inputs
idstringrequired- ULID of the profit center. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestring- Profit center name, up to 24 characters. Example: Prints.
tave_profit_center_updateReplace a profit center (PUT: name is required and the whole record is resent).WriteUpdate Profit Center
Replace a profit center (PUT: name is required and the whole record is resent). Returns the updated profit center. Use tave_profit_center_update to rename a profit center. Use tave_profit_center_partial_update (PATCH) to send only changed fields.
- Idempotent
Inputs
idstringrequired- ULID of the profit center. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestringrequired- Profit center name, up to 24 characters. Example: Prints.
tave_quote_bookBook a quote, turning the chosen option into an order.WriteBook Quote
Book a quote, turning the chosen option into an order. Returns the new order. Use tave_quote_book when the client accepts.
Inputs
idstringrequired- ULID of the quote. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
due_datestring- First payment due date (YYYY-MM-DD). Example: 2026-12-01.
option_idstring- ULID of the chosen option (required for advanced quotes). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
recipient_idstring- ULID of the contact who booked. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
sold_atstring- Booking date (YYYY-MM-DD). Defaults to today. Example: 2026-11-16.
tave_quote_createCreate a quote on a job with one or more priced options.WriteCreate Quote
Create a quote on a job with one or more priced options. Returns the new quote. Use tave_quote_create to price a lead; send it with tave_quote_send.
Inputs
job_idstringrequired- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
namestringrequired- Quote name. Example: Wedding collections.
introductionstring- Introduction text shown to the client. Example: Thank you for considering us!.
kindstring- simple (exactly one option) or advanced (several options to choose from). Example: simple.one of
simpleadvanced optionsarray- Priced options; a simple quote has exactly one. Each option has lineItems, each with a name and optionally productId, units and pricePerUnit (minor units). Example: [{"lineItems": [{"productId": "01j8z3k4m5n6p7q8r9s0t1v2y5", "name": "Full day coverage", "units": 1, "pricePerUnit": 350000}]}].
recipientsarray- Recipients, required when the job has no client contacts. Example: [{"contactId": "01j8z3k4m5n6p7q8r9s0t1v2x4"}].
tave_quote_sendEmail a quote invitation to its recipients, or create the email as a draft.WriteSend Quote
Email a quote invitation to its recipients, or create the email as a draft. Returns the queued mail message. Use tave_quote_send after tave_quote_create. Set resend true to send again.
Inputs
idstringrequired- ULID of the quote. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
resendbooleanrequired- Must be true to send again to recipients already emailed; false for a first send. Example: false.
draftboolean- true to create a draft email without sending. Example: false.
mail_message_template_idstring- ULID of a mail template to use. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
recipient_contact_idsarray- Subset of quote recipient contact IDs to email; all recipients when empty. Example: ["01j8z3k4m5n6p7q8r9s0t1v2x4"].
tave_rest_hook_createSubscribe a target URL to a VSCO Workspace event (REST Hooks webhook): contact.created, job.created, order.booked or payment.created.WriteCreate REST Hook
Subscribe a target URL to a VSCO Workspace event (REST Hooks webhook): contact.created, job.created, order.booked or payment.created. Returns the new subscription with its id. Each postback to the URL contains only the targetId of the new entity. Use tave_rest_hook_create to get notified of new records; fetch the record with tave_contact_get, tave_job_get, tave_order_get or tave_payment_get. Use tave_rest_hooks_list to check for an existing subscription first. Optional filters narrow the subscription by contact kind, job type (tave_job_types_list), brand (tave_brands_list) or web lead.
Inputs
eventstringrequired- Event that triggers the webhook: contact.created, job.created, order.booked or payment.created. Example: job.created.one of
contact.createdjob.createdorder.bookedpayment.created urlstringrequired- Target URL that VSCO Workspace POSTs to when the event happens. The postback carries only the targetId of the new entity; fetch the entity with the matching get tool. Example: https://hooks.example.com/tave/job-created.
brand_idsarray- Only fire for records in these brand ULIDs (from tave_brands_list). Example: ["01j8z3k4m5n6p7q8r9s0t1v2y5"].
contact_kindsarray- Only fire for these address book kinds (person, company, location). Valid only for contact.created. Example: ["person"].
job_type_idsarray- Only fire for jobs of these job type ULIDs (from tave_job_types_list). Not valid for contact.created. Example: ["01j8z3k4m5n6p7q8r9s0t1v2y5"].
web_leadboolean- true to fire only for jobs created from a web lead (contact form). Valid only for job.created. Example: true.
tave_rest_hook_partial_updateChange only the fields you send on a REST Hook webhook subscription (PATCH); omitted fields keep their values.WritePartially Update REST Hook
Change only the fields you send on a REST Hook webhook subscription (PATCH); omitted fields keep their values. Returns the updated subscription. Use tave_rest_hook_partial_update to change the target URL, event or one filter. Use tave_rest_hook_update (PUT) to replace the whole subscription.
- Idempotent
Inputs
idstringrequired- ULID of the REST Hook subscription. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
brand_idsarray- Only fire for records in these brand ULIDs (from tave_brands_list). Example: ["01j8z3k4m5n6p7q8r9s0t1v2y5"].
contact_kindsarray- Only fire for these address book kinds (person, company, location). Valid only for contact.created. Example: ["person"].
eventstring- Event that triggers the webhook: contact.created, job.created, order.booked or payment.created. Example: job.created.one of
contact.createdjob.createdorder.bookedpayment.created job_type_idsarray- Only fire for jobs of these job type ULIDs (from tave_job_types_list). Not valid for contact.created. Example: ["01j8z3k4m5n6p7q8r9s0t1v2y5"].
urlstring- Target URL that VSCO Workspace POSTs to when the event happens. The postback carries only the targetId of the new entity; fetch the entity with the matching get tool. Example: https://hooks.example.com/tave/job-created.
web_leadboolean- true to fire only for jobs created from a web lead (contact form). Valid only for job.created. Example: true.
tave_rest_hook_updateReplace a REST Hook webhook subscription (PUT: event and url are required, and filters you omit are cleared).WriteUpdate REST Hook
Replace a REST Hook webhook subscription (PUT: event and url are required, and filters you omit are cleared). Returns the updated subscription. Use tave_rest_hook_update to rewrite a subscription; read it with tave_rest_hook_get first. Use tave_rest_hook_partial_update (PATCH) to change only some fields.
- Idempotent
Inputs
eventstringrequired- Event that triggers the webhook: contact.created, job.created, order.booked or payment.created. Example: job.created.one of
contact.createdjob.createdorder.bookedpayment.created idstringrequired- ULID of the REST Hook subscription. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
urlstringrequired- Target URL that VSCO Workspace POSTs to when the event happens. The postback carries only the targetId of the new entity; fetch the entity with the matching get tool. Example: https://hooks.example.com/tave/job-created.
brand_idsarray- Only fire for records in these brand ULIDs (from tave_brands_list). Example: ["01j8z3k4m5n6p7q8r9s0t1v2y5"].
contact_kindsarray- Only fire for these address book kinds (person, company, location). Valid only for contact.created. Example: ["person"].
job_type_idsarray- Only fire for jobs of these job type ULIDs (from tave_job_types_list). Not valid for contact.created. Example: ["01j8z3k4m5n6p7q8r9s0t1v2y5"].
web_leadboolean- true to fire only for jobs created from a web lead (contact form). Valid only for job.created. Example: true.
tave_studio_updateUpdate the settings of the studio the API key belongs to: name, contact email, owner name, currency, timezone, default brand and display formats (PUT: name is required).WriteUpdate My Studio
Update the settings of the studio the API key belongs to: name, contact email, owner name, currency, timezone, default brand and display formats (PUT: name is required). Returns the updated studio. Use tave_studio_update to change studio settings; read current values with tave_studio_get first and resend the name. Use tave_studio_readonly_mode_set to lock or unlock the studio.
- Idempotent
Inputs
namestringrequired- Studio name, up to 255 characters. Required by PUT. Example: Rivera Photography.
currency_codestring- Three-letter ISO 4217 currency code for the studio. Example: USD.
date_formatstring- Date display format: n/j/Y (US), j/n/Y (day first) or Y-m-d (ISO). Example: n/j/Y.one of
n/j/Yj/n/YY-m-d decimal_separatorstring- Decimal separator for numbers: period or comma. Example: ..one of
,. default_brand_idstring- ULID of the default brand (from tave_brands_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
emailstring- Studio email address. Example: hello@riveraphoto.com.
first_namestring- Studio owner's first name, up to 48 characters. Example: Ana.
last_namestring- Studio owner's last name, up to 48 characters. Example: Rivera.
temperaturestring- Temperature unit for weather: Celsius or Fahrenheit. Example: Fahrenheit.one of
CelsiusFahrenheit thousands_separatorstring- Thousands separator for numbers: comma or period. Example: ,.one of
,. time_formatstring- Time display format: g:ia (12-hour) or H:i (24-hour). Example: g:ia.one of
g:iaH:i timezone_idstring- ULID of the studio timezone (from tave_timezones_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
week_starts_onstring- First day of the week in calendars. Example: Monday.one of
SundayMondayTuesdayWednesdayThursdayFridaySaturday
tave_task_createCreate a task in a task list, optionally on a job and assigned to a user.WriteCreate Task
Create a task in a task list, optionally on a job and assigned to a user. Returns the new task. Use tave_task_create for a follow-up. Get task list IDs from tave_task_lists_list.
Inputs
namestringrequired- Task name. Example: Send timeline questionnaire.
task_list_idstringrequired- ULID of the task list (from tave_task_lists_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
completedboolean- true when the task is done. Example: false.
due_datestring- Due date (YYYY-MM-DD). Example: 2026-12-05.
job_idstring- ULID of the job the task belongs to. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
user_idstring- ULID of the user the task is assigned to. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_task_updateUpdate a task, for example to complete it or change its due date (PUT replaces the task: resend name, task list and the other fields to keep).WriteUpdate Task
Update a task, for example to complete it or change its due date (PUT replaces the task: resend name, task list and the other fields to keep). Returns the updated task. Use tave_task_update with completed true to finish a task.
- Idempotent
Inputs
idstringrequired- ULID of the task. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
namestringrequired- Task name. Example: Send timeline questionnaire.
task_list_idstringrequired- ULID of the task list (from tave_task_lists_list). Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
completedboolean- true when the task is done. Example: false.
due_datestring- Due date (YYYY-MM-DD). Example: 2026-12-05.
job_idstring- ULID of the job the task belongs to. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
user_idstring- ULID of the user the task is assigned to. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_tax_group_createCreate a tax group of up to 3 tax rates, optionally compounding or set as the studio default.WriteCreate Tax Group
Create a tax group of up to 3 tax rates, optionally compounding or set as the studio default. Returns the new tax group with its id. Use tave_tax_group_create to combine rates (for example state plus city). Use tave_tax_rate_create for a single standalone rate.
Inputs
namestringrequired- Tax group name, up to 64 characters. Example: New York City.
compoundingboolean- true to apply each rate on top of the previous ones (tax on tax). Defaults to false. Example: false.
defaultboolean- true to make this the studio's default tax group. Defaults to false. Example: false.
tax_ratesarray- Up to 3 tax rates in the group, each an object with name, rate (percentage) and inclusive (true if prices include the tax). Example: [{"name": "NY State", "rate": 4, "inclusive": false}].
tave_tax_group_updateUpdate a tax group (PUT replaces the group: read it with tave_tax_group_get first and resend the rates and flags you want to keep).WriteUpdate Tax Group
Update a tax group (PUT replaces the group: read it with tave_tax_group_get first and resend the rates and flags you want to keep). Returns the updated tax group. Use tave_tax_group_update to change a group's name, rates or default flag. Use tave_tax_rate_update for a standalone rate.
- Idempotent
Inputs
idstringrequired- ULID of the tax group. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
compoundingboolean- true to apply each rate on top of the previous ones (tax on tax). Defaults to false. Example: false.
defaultboolean- true to make this the studio's default tax group. Defaults to false. Example: false.
namestring- Tax group name, up to 64 characters. Example: New York City.
tax_ratesarray- Up to 3 tax rates in the group, each an object with name, rate (percentage) and inclusive (true if prices include the tax). Example: [{"name": "NY State", "rate": 4, "inclusive": false}].
tave_tax_rate_createCreate a tax rate as a percentage, either added on top of prices or included in them.WriteCreate Tax Rate
Create a tax rate as a percentage, either added on top of prices or included in them. Returns the new tax rate with its id. Use tave_tax_rate_create for a single rate. Use tave_tax_group_create to combine up to 3 rates.
Inputs
ratenumberrequired- Tax rate as a percentage, up to 4 decimal places (8.875 means 8.875%). Example: 8.875.
inclusiveboolean- true if prices already include this tax; false adds it on top. Defaults to false. Example: false.
namestring- Tax rate name, up to 32 characters. Example: NY Sales Tax.
tave_tax_rate_updateUpdate a tax rate (PUT replaces the rate: read it with tave_tax_rate_get first and resend fields you want to keep).WriteUpdate Tax Rate
Update a tax rate (PUT replaces the rate: read it with tave_tax_rate_get first and resend fields you want to keep). Returns the updated tax rate. Use tave_tax_rate_update to change a rate's name, percentage or inclusive flag. Use tave_tax_group_update for a group.
- Idempotent
Inputs
idstringrequired- ULID of the tax rate. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
inclusiveboolean- true if prices already include this tax; false adds it on top. Defaults to false. Example: false.
namestring- Tax rate name, up to 32 characters. Example: NY Sales Tax.
ratenumber- Tax rate as a percentage, up to 4 decimal places (8.875 means 8.875%). Example: 8.875.
tave_user_createAdd a team member (user) to the studio with a sign-in email and admin or billing-contact flags.WriteCreate User
Add a team member (user) to the studio with a sign-in email and admin or billing-contact flags. Returns the new user with id, username and contactId (the address book contact holding the user's name and phone). Use tave_user_create to add staff. Use tave_users_list to check the user does not already exist; edit the user's name or phone on the linked contact with tave_contact_update. Each user is tied to an address book contact; the API sets contactId, and tave_contact_create creates standalone address book entries.
Inputs
usernamestringrequired- Email address the user signs in with, 5 to 64 characters. Example: jordan@riveraphoto.com.
is_adminboolean- true to give the user admin rights in the studio. Defaults to false. Example: false.
is_billing_contactboolean- true to make the user the studio's billing contact. Defaults to false. Example: false.
tave_user_updateUpdate a studio user's sign-in email and admin or billing-contact flags (PUT replaces the user: read it with tave_user_get first and resend fields you want to keep).WriteUpdate User
Update a studio user's sign-in email and admin or billing-contact flags (PUT replaces the user: read it with tave_user_get first and resend fields you want to keep). Returns the updated user. Use tave_user_update to change a user's email or permissions. Use tave_contact_update on the user's contactId to change name or phone.
- Idempotent
Inputs
idstringrequired- ULID of the user. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
is_adminboolean- true to give the user admin rights in the studio. Defaults to false. Example: false.
is_billing_contactboolean- true to make the user the studio's billing contact. Defaults to false. Example: false.
usernamestring- Email address the user signs in with, 5 to 64 characters. Example: jordan@riveraphoto.com.
tave_brand_deleteDelete a brand.DestructiveDelete Brand
Delete a brand. Returns no content on success. Use tave_brand_delete to remove an unused brand; use tave_brand_update to change one instead.
- Idempotent
Inputs
idstringrequired- ULID of the brand. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_contact_deleteDelete an address book entry.DestructiveDelete Address Book Entry
Delete an address book entry. Returns no content on success. Use tave_contact_delete to remove a duplicate contact.
- Idempotent
Inputs
idstringrequired- ULID of the address book entry. Example: 01j8z3k4m5n6p7q8r9s0t1v2x4.
tave_custom_field_deleteDelete a custom field definition.DestructiveDelete Custom Field
Delete a custom field definition. Returns no content on success. Use tave_custom_field_delete to remove a field no longer used; use tave_custom_field_update to rename or change it instead.
- Idempotent
Inputs
idstringrequired- ULID of the custom field. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_discount_deleteDelete a discount.DestructiveDelete Discount
Delete a discount. Returns no content on success. Use tave_discount_delete to remove a discount; use tave_discount_type_delete to remove a discount type.
- Idempotent
Inputs
idstringrequired- ULID of the discount. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_discount_type_deleteDelete a discount type.DestructiveDelete Discount Type
Delete a discount type. Returns no content on success. Use tave_discount_type_delete to remove a category; use tave_discount_delete to remove a single discount.
- Idempotent
Inputs
idstringrequired- ULID of the discount type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_event_deleteDelete an event.DestructiveDelete Event
Delete an event. Returns no content on success. Use tave_event_delete to cancel an event.
- Idempotent
Inputs
idstringrequired- ULID of the event. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_event_type_deleteDelete an event type.DestructiveDelete Event Type
Delete an event type. Returns no content on success. Use tave_event_type_delete to remove an unused type; use tave_event_delete to cancel a single event.
- Idempotent
Inputs
idstringrequired- ULID of the event type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_file_deleteDelete a file.DestructiveDelete File
Delete a file. Returns no content on success. Use tave_file_delete to remove a file permanently. Use tave_file_update to detach it from a record instead.
- Idempotent
Inputs
idstringrequired- ULID of the file. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_gallery_deleteDelete a client gallery record from the studio.DestructiveDelete Gallery
Delete a client gallery record from the studio. Returns no content on success. Use tave_gallery_delete to remove a gallery. Use tave_gallery_update with status archived to keep it.
- Idempotent
Inputs
idstringrequired- ULID of the gallery. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_job_closed_reason_deleteDelete a job closed reason.DestructiveDelete Job Closed Reason
Delete a job closed reason. Returns no content on success. Use tave_job_closed_reason_delete to remove a reason. Use tave_job_closed_reason_partial_update to rename it instead.
- Idempotent
Inputs
idstringrequired- ULID of the job closed reason. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_job_contact_deleteRemove a contact from a job (the contact itself is kept).DestructiveRemove Contact from Job
Remove a contact from a job (the contact itself is kept). Returns no content on success. Use tave_job_contact_delete to unlink a contact.
- Idempotent
Inputs
idstringrequired- ULID of the job contact. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_job_deleteDelete a job.DestructiveDelete Job
Delete a job. Returns no content on success. Use tave_job_delete only for test or duplicate jobs; close real ones with tave_job_update.
- Idempotent
Inputs
idstringrequired- ULID of the job. Example: 01j8z3k4m5n6p7q8r9s0t1v2w3.
tave_job_role_deleteDelete a job role.DestructiveDelete Job Role
Delete a job role. Returns no content on success. Use tave_job_role_delete to remove a role. Use tave_job_role_update to rename it instead.
- Idempotent
Inputs
idstringrequired- ULID of the job role. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_job_type_deleteDelete a job type.DestructiveDelete Job Type
Delete a job type. Returns no content on success. Use tave_job_type_delete to remove a type. Use tave_job_type_update to rename it instead.
- Idempotent
Inputs
idstringrequired- ULID of the job type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_lead_source_deleteDelete a lead source.DestructiveDelete Lead Source
Delete a lead source. Returns no content on success. Use tave_lead_source_delete to remove a channel you no longer track. Use tave_lead_source_update to rename it instead.
- Idempotent
Inputs
idstringrequired- ULID of the lead source. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_lead_status_deleteDelete a lead status.DestructiveDelete Lead Status
Delete a lead status. Returns no content on success. Use tave_lead_status_delete to remove a stage you no longer use. Use tave_lead_status_partial_update to rename it instead.
- Idempotent
Inputs
idstringrequired- ULID of the lead status. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_note_deleteDelete a note.DestructiveDelete Note
Delete a note. Returns no content on success. Use tave_note_delete to remove a note.
- Idempotent
Inputs
idstringrequired- ULID of the note. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_order_voidVoid an order so it no longer bills the client.DestructiveVoid Order
Void an order so it no longer bills the client. Returns the voided order. Use tave_order_void to cancel a booked order.
Inputs
idstringrequired- ULID of the order. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_payment_deleteDelete a recorded payment.DestructiveDelete Payment
Delete a recorded payment. Returns no content on success. Use tave_payment_delete to remove a payment recorded in error. Use tave_payment_update to correct its details instead.
- Idempotent
Inputs
idstringrequired- ULID of the payment. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_product_deleteDelete a product or service.DestructiveDelete Product
Delete a product or service. Returns no content on success. Use tave_product_delete to remove a product you no longer sell. Use tave_product_partial_update or tave_product_update to change it instead.
- Idempotent
Inputs
idstringrequired- ULID of the product. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_product_type_deleteDelete a product type.DestructiveDelete Product Type
Delete a product type. Returns no content on success. Use tave_product_type_delete to remove a category you no longer use.
- Idempotent
Inputs
idstringrequired- ULID of the product type. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_profit_center_deleteDelete a profit center.DestructiveDelete Profit Center
Delete a profit center. Returns no content on success. Use tave_profit_center_delete to remove an unused category. Move products to another profit center first with tave_product_update.
- Idempotent
Inputs
idstringrequired- ULID of the profit center. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_rest_hook_deleteUnsubscribe and delete a REST Hook webhook subscription; the target URL stops receiving postbacks.DestructiveDelete REST Hook
Unsubscribe and delete a REST Hook webhook subscription; the target URL stops receiving postbacks. Returns no content on success. Use tave_rest_hook_delete to stop a webhook. Use tave_rest_hooks_list to find the subscription ID.
- Idempotent
Inputs
idstringrequired- ULID of the REST Hook subscription. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_studio_readonly_mode_setTurn read-only mode on or off for the whole studio.DestructiveSet Studio Read-Only Mode
Turn read-only mode on or off for the whole studio. While on, the studio is locked: no one can create or change jobs, contacts, orders, payments or other records until it is turned off. Returns the studio, including readonlyEnabledAt when read-only mode is on. Use tave_studio_readonly_mode_set only when the studio owner explicitly asks to lock or unlock the studio. Use tave_studio_update for ordinary settings and tave_studio_get to check the current state.
- Idempotent
Inputs
enabledbooleanrequired- true locks the whole studio in read-only mode; false unlocks it. Example: false.
tave_task_deleteDelete a task.DestructiveDelete Task
Delete a task. Returns no content on success. Use tave_task_delete to remove a task.
- Idempotent
Inputs
idstringrequired- ULID of the task. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_tax_group_deleteDelete a tax group.DestructiveDelete Tax Group
Delete a tax group. Returns no content on success. Use tave_tax_group_delete to remove a group. Use tave_tax_rate_delete for a standalone rate.
- Idempotent
Inputs
idstringrequired- ULID of the tax group. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
tave_tax_rate_deleteDelete a tax rate.DestructiveDelete Tax Rate
Delete a tax rate. Returns no content on success. Use tave_tax_rate_delete to remove a rate. Use tave_tax_group_delete for a tax group.
- Idempotent
Inputs
idstringrequired- ULID of the tax rate. Example: 01j8z3k4m5n6p7q8r9s0t1v2y5.
No tools match.