Tave

tave

Tave is the best Studio Management Application for Photographers, providing tools for client management, job tracking, and business operations.

CRM Scheduling & Booking Web del proveedor

Acciones

129

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (129)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Apply Payment to OrderTAVE_APPLY_PAYMENT_TO_ORDERAcción

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

Parámetros de entrada

idstringObligatorio
ULID of the payment to apply. This is the unique identifier of the payment that will be applied to the order.
amountintegerObligatorio
Positive numeric representing an amount in the studio's currency. The amount of the payment to apply to the order.
orderIdstringObligatorio
ULID of the order to apply the payment to. This is the unique identifier of the order that will receive the payment.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create BrandTAVE_CREATE_BRANDAcción

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

Parámetros de entrada

bccstring
BCC email address for all outgoing emails from this brand.
namestringObligatorio
The brand's name. Must be between 4 and 128 characters.
aliasstringObligatorio
Unique alias for the brand URL. Must be between 4 and 32 characters.
themeobject
Brand theme configuration.
phone1object
Brand phone number with label.
phone2object
Brand phone number with label.
phone3object
Brand phone number with label.
replyTostring
Reply-to email address for emails sent from this brand.
forwardTostring
Email address to forward incoming messages to.
shortNamestringObligatorio
A shorter name for the brand to be used in constrained UI places.
locationIdstring
ULID identifier of the location associated with this brand.
officeHoursstring
Office hours information text.
customDomainstring
Custom domain for the brand's client portal.
externalMappingsobject[]
List of external system mappings for this brand.
enableProfileEditboolean
Whether clients can edit their profile information.
googleAnalyticsIdstring
Google Analytics tracking ID. Must match pattern (UA|YT|MO)-\d+-\d+
rootContactFormIdstring
ULID identifier of the root contact form for this brand.
clientAccessVersionintegerObligatorio
Client access version number. Must be between 1 and 10.
showHistoryInPortalboolean
Whether to show interaction history in the client portal.
breakoutPackagePricingboolean
Whether to break out package pricing in client-facing views.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Custom FieldTAVE_CREATE_CUSTOM_FIELDAcción

Tool to create a custom field in Tave for Jobs or Contacts. Use when you need to add custom data fields to capture additional information specific to your business workflow.

Parámetros de entrada

kindstringenum
The type of input field (TextField, TextBox, DropDown, Number, Decimal, Money, Date, Time, Checkbox)
TextFieldTextBoxDropDownNumberDecimalMoneyDateTimeCheckbox
namestringObligatorio
The name of the custom field
tokenstring
A unique token identifier for this custom field
hiddenboolean
Whether this custom field should be hidden from view
choicesstring[]
List of choices for DropDown field type. Required when kind is DropDown
canApplyTostringenum
The resource type this field can be applied to (Job or Contact)
JobContact
clientLabelstring
The label to display to clients when they have access to this field
clientAccessstringenum
Client access level for this field (None, Visible, Editable)
NoneVisibleEditable

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Discount TypeTAVE_CREATE_DISCOUNT_TYPEAcción

Tool to create a new discount type in Tave. Use when you need to create a new discount category for organizing discounts. The name field is required and must be 255 characters or less.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create GalleryTAVE_CREATE_GALLERYAcción

Tool to create a new gallery in Tave (VSCO Workspace). Use when you need to create a gallery with a name, client URL, and admin URL. Note that remoteId and remoteCreated are also required.

Parámetros de entrada

namestringObligatorio
The name of this gallery.
slugstring
The URL path slug for this gallery. Must contain only letters, numbers, dashes, and underscores. Will be converted to lowercase.
jobIdstring
A ULID entity identifier for the job this gallery is associated with.
hiddenboolean
Whether this gallery is hidden.
publicboolean
Whether this gallery is publicly accessible.
eventIdstring
A ULID entity identifier for the event this gallery is associated with.
adminUrlstringObligatorio
The internal URL of this gallery in the remote admin portal. May be used to link employees to the gallery administration interface in the remote service.
categorystring
The category of this gallery. Galleries may be grouped by this category text in future client portal designs.
headlinestring
The headline of this gallery. Prioritized over name when displayed to the user.
passwordstring
A reusable plain-text passcode for unlocking the gallery. This pass code may be given to invited users.
remoteIdstringObligatorio
The remote ID of this gallery. This value must be unique for the studio.
clientUrlstringObligatorio
The URL of this gallery. Will be used for links in emails and the client portal.
eventDatestring
The date of the event this gallery is for in YYYY-MM-DD format. Useful in automations or email tokens.
coverPhotoobject
Cover photo details for a gallery.
releaseDatestring
The date this gallery will be released to the public in YYYY-MM-DD format. Useful in automations or email tokens.
orderDueDatestring
The date that orders for this gallery are due by in YYYY-MM-DD format. Useful in automations or email tokens.
remoteCreatedstringObligatorio
The creation date and time of this gallery in UTC (ISO 8601 format).
expirationDatestring
The date this gallery will expire and no longer be accessible in YYYY-MM-DD format. Useful in automations or email tokens.
externalMappingsobject[]
External mappings to relate this gallery to entities in external systems.
requiresPasswordboolean
Whether this gallery requires a password for access. Defaults to true.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Address Book EntryTAVE_CREATE_RESOURCE_ADDRESS_BOOKAcción

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

Parámetros de entrada

kindstringObligatorioenum
Type of address book entry. Valid values: 'person', 'company', 'location'
personcompanylocation
emailstring
Email address of the contact
lastNamestring
Last name of the person (for kind='person')
firstNamestring
First name of the person (for kind='person')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create DiscountTAVE_CREATE_RESOURCE_DISCOUNTAcción

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

Parámetros de entrada

skustring
Stock Keeping Unit (SKU) for the discount.
kindstringenum
Enum for discount kind values.
AmountPercent
namestringObligatorio
The name of the discount.
priceintegerObligatorio
Positive numeric representing an amount in the studio's currency. For percentage discounts, this represents the percentage value (e.g., 10 for 10%).
hiddenboolean
Whether or not the discount is hidden.
rebateboolean
Whether the discount is a rebate. Defaults to false.
typeIdstringObligatorio
A lowercase ULID entity identifier for the discount type.
manualEntryboolean
Whether the discount allows manual entry. Defaults to true.
descriptionHtmlstring
HTML description of the discount.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create EventTAVE_CREATE_RESOURCE_EVENTAcción

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

Parámetros de entrada

namestring
Name or title of the event
jobIdstring
ULID identifier of the associated job
allDayboolean
Whether this is an all-day event
hiddenboolean
Whether the event is hidden
typeIdstring
ULID identifier of the event type
channelstringenum
Channel through which the event will take place.
InPersonPhoneVirtual
endDatestring
Event end date in YYYY-MM-DD format (in event timezone)
endTimestring
Event end time in 24-hour HH:MM:SS format
locationobject
Event location information.
confirmedboolean
Whether the event is confirmed
galleryIdstring
ULID identifier of the associated gallery
startDatestring
Event start date in YYYY-MM-DD format (in event timezone)
startTimestring
Event start time in 24-hour HH:MM:SS format
timezoneIdstring
ULID identifier of the timezone
virtualUrlstring
Virtual meeting URL for online events
phoneNumberobject
Representation of a phone number.
timezoneNamestring
VSCO Workspace approved timezone name. Ignored if timezoneId is provided.
descriptionHtmlstring
HTML-formatted description of the event
externalMappingsobject[]
Mappings to external system entities

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Event TypeTAVE_CREATE_RESOURCE_EVENT_TYPEAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create FileTAVE_CREATE_RESOURCE_FILEAcción

Tool to create a file in Tave. Use when you need to upload a new file with binary data or link to a remote file. The file can be attached to entities and include metadata. For image files, you can specify dimensions, crop settings, and GPS coordinates.

Parámetros de entrada

namestring
Display name for the file (if different from filename)
hiddenboolean
Whether the file should be hidden
typeIdstring
ULID identifier of the file type
filenamestringObligatorio
Name of the file to create (required)
mimeTypestring
MIME type of the file (e.g., 'text/plain', 'application/pdf', 'image/png')
remoteUrlstring
URL to a remote file location instead of providing binaryData
attachedToobject[]
List of entities this file is attached to
binaryDatastring
Base64-encoded binary data of the file. Maximum size is 20MB.
descriptionstring
Description of the file
imageMetaDataobject
Metadata for image files
externalMappingsobject[]
List of external system mappings for this file

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create JobTAVE_CREATE_RESOURCE_JOBAcción

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

Parámetros de entrada

namestring
Name of the job that will override the auto-generated title
stagestringObligatorioenum
Stage that the job is in (lead, booked, fulfillment, or completed)
leadbookedfulfillmentcompleted
closedboolean
Whether the lead or job is closed
pinnedboolean
Whether the job is favorited/pinned
sampleboolean
Whether the lead or job is a sample job
brandIdstring
ULID identifier of the brand
webLeadboolean
Whether the lead or job came from a contact form
eventDatestring
Event date in YYYY-MM-DD format (in studio timezone)
jobTypeIdstring
ULID identifier of the job type
leadNotesstring
Notes about the lead
closedDatestring
Date when the job was closed in YYYY-MM-DD format (in studio timezone)
guestCountinteger
Number of guests for the event
leadRatinginteger
Rating for the lead (1-5)
workflowIdstring
ULID identifier of the workflow
bookingDatestring
Booking date in YYYY-MM-DD format (in studio timezone)
inquiryDatestring
Inquiry date in YYYY-MM-DD format (in studio timezone)
customFieldsobject[]
List of custom field values for the job
customNumberstring
Custom job number or identifier
leadSourceIdstring
ULID identifier of the lead source
leadStatusIdstring
ULID identifier of the lead status
completedDatestring
Completion date in YYYY-MM-DD format (in studio timezone)
contactFormIdstring
ULID identifier of the contact form
leadMaxBudgetinteger
Maximum budget for the lead in the studio's currency
closedReasonIdstring
ULID identifier of the closed reason
leadConfidencestringenum
Confidence level for a lead.
lowmediumhigh
fulfillmentDatestring
Fulfillment date in YYYY-MM-DD format (in studio timezone)
externalMappingsobject[]
List of external system mappings
leadDecisionExpectedByDatestring
Expected decision date for the lead in YYYY-MM-DD format (in studio timezone)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Job Closed ReasonTAVE_CREATE_RESOURCE_JOB_CLOSED_REASONAcción

Tool to create a job closed reason in Tave. Use when you need to add a new reason for why jobs are closed. Job closed reasons help track why opportunities didn't convert into bookings.

Parámetros de entrada

namestringObligatorio
Name of the job closed reason (required, 1-32 characters)
hiddenboolean
Whether the job closed reason is hidden
descriptionstring
Description of the job closed reason (max 64 characters)
externalMappingsobject[]
List of external system mappings for this job closed reason
includedInReportingboolean
Whether this reason should be included in reporting

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Job ContactTAVE_CREATE_RESOURCE_JOB_CONTACTAcción

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

Parámetros de entrada

jobIdstringObligatorio
A lowercase ULID entity identifier for the job
clientboolean
Whether the contact is marked as a client. Defaults to false.
hiddenboolean
Whether or not the object is hidden
jobRolesarray
List of ULID entity identifiers for job roles assigned to this contact
contactIdstringObligatorio
A lowercase ULID entity identifier for the contact
roleKindsstring[]
List of role kinds (client, customer, team, subject, vendor) for the contact
externalMappingsobject[]
Mappings to external system entities. These objects cannot be updated currently.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Job OrderTAVE_CREATE_RESOURCE_JOB_ORDERAcción

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

Parámetros de entrada

namestring
Custom name for the order
jobIdstringObligatorio
ULID identifier of the job to create the order on
titlestring
Name or auto-generated title of the order
hiddenboolean
Whether the order is hidden
statusstringenum
Status of the order.
draftopenpaid-in-fullcompletedvoided
dueDatestring
Due date for the order in YYYY-MM-DD format
bookedOnstring
Date when the order was booked in YYYY-MM-DD format
lineItemsobject[]
List of line items for the order
taxGroupIdstring
ULID identifier of the tax group for calculating taxes
recipientIdstring
ULID identifier of the recipient from the address book
customNumberstring
Custom order number or identifier
paymentTermsIdstring
ULID identifier of the payment terms
preTaxDiscountobject
Discount applied to an order.
bookedFromQuoteboolean
Whether the order was booked from a quote
afterTaxDiscountobject
Discount applied to an order.
bookedElectronicallyboolean
Whether the order was booked electronically

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Job RoleTAVE_CREATE_RESOURCE_JOB_ROLEAcción

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

Parámetros de entrada

kindstringenum
Kind of job role entity.
customersubjectteamvendor
namestringObligatorio
Name of the job role (1-24 characters)
hiddenboolean
Whether the job role is hidden
tokenPrefixstringObligatorio
Unique prefix identifier for placeholders (1-32 lowercase alphanumeric characters or underscores). Reserved prefixes that cannot be used: booked_order, brand, clients, contract, custom, customers, event, invoice, item, job, quote, order, payment, payment_schedule, primary_session, recipient, subjects, tave, team, vendors
sortPositioninteger
Sort position for ordering job roles (0-65535). Defaults to 100 if not specified.
externalMappingsobject[]
List of external system mappings (cannot be updated after creation)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Job TypeTAVE_CREATE_RESOURCE_JOB_TYPEAcción

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

Parámetros de entrada

namestringObligatorio
The name of this job type
hiddenboolean
Whether or not the job type is hidden
workflowIdstring
ULID identifier of the workflow for this job type
sortPositioninteger
Sort position for ordering job types (0-65535). Defaults to 100
defaultEventsobject[]
List of default event types to associate with this job type
profitCenterIdstring
ULID identifier of the profit center for this job type
defaultContactsobject[]
List of default job roles to associate with this job type
externalMappingsobject[]
List of external system mappings for this job type
initialLeadStatusIdstring
ULID identifier of the initial lead status for this job type
primarySessionRequiredboolean
Whether a primary session is required for jobs of this type. Defaults to true

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Job WorksheetTAVE_CREATE_RESOURCE_JOB_WORKSHEETAcción

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

Parámetros de entrada

namestringObligatorio
Name of the job that will override the auto-generated title
titlestringObligatorio
Title for the job
closedboolean
Whether the lead or job is closed
eventsobject[]
List of events associated with this job
pinnedboolean
Whether the job is favorited/pinned
sampleboolean
Whether the lead or job is a sample job
brandIdstring
ULID identifier of the brand
webLeadboolean
Whether the lead or job came from a contact form
contactsobject[]
List of contacts associated with this job
eventDatestring
Event date in YYYY-MM-DD format (in studio timezone)
jobTypeIdstring
ULID identifier of the job type
leadNotesstring
Notes about the lead
closedDatestring
Date when the job was closed in YYYY-MM-DD format (in studio timezone)
guestCountinteger
Number of guests for the event
leadRatinginteger
Rating for the lead (1-5)
workflowIdstring
ULID identifier of the workflow
bookingDatestring
Booking date in YYYY-MM-DD format (in studio timezone)
inquiryDatestring
Inquiry date in YYYY-MM-DD format (in studio timezone)
customFieldsobject[]
List of custom field values for the job
customNumberstring
Custom job number or identifier
leadSourceIdstring
ULID identifier of the lead source
leadStatusIdstring
ULID identifier of the lead status
completedDatestring
Completion date in YYYY-MM-DD format (in studio timezone)
contactFormIdstring
ULID identifier of the contact form
leadMaxBudgetinteger
Maximum budget for the lead in the studio's currency
closedReasonIdstring
ULID identifier of the closed reason
leadConfidencestringenum
Confidence level for a lead.
lowmediumhigh
fulfillmentDatestring
Fulfillment date in YYYY-MM-DD format (in studio timezone)
externalMappingsobject[]
List of external system mappings
leadDecisionExpectedByDatestring
Expected decision date for the lead in YYYY-MM-DD format (in studio timezone)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Lead SourceTAVE_CREATE_RESOURCE_LEAD_SOURCEAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Lead StatusTAVE_CREATE_RESOURCE_LEAD_STATUSAcción

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

Parámetros de entrada

kindstringenum
Kind of lead status.
generalnewstale
namestringObligatorio
The name of the lead status. Must be between 1 and 64 characters.
colorstring
Hex color code (6 characters) for the lead status display, without the # prefix.
hiddenboolean
Whether or not the lead status is hidden. Defaults to false.
sortPositioninteger
Sort position for ordering lead statuses. Defaults to 100.
transitionToIdstring
A ULID entity identifier for the lead status to transition to after a specified interval.
externalMappingsobject[]
List of external system mappings for this lead status.
transitionIntervalinteger
The interval duration before transitioning to another status.
transitionIntervalUnitstringenum
Unit for transition interval.
dayweekmonthyear
transitionClosedReasonIdstring
A ULID entity identifier for the closed reason when transitioning.
afterFormSentTransitionToIdstring
A ULID entity identifier for the lead status to transition to after a form is sent.
afterEmailSentTransitionToIdstring
A ULID entity identifier for the lead status to transition to after an email is sent.
afterQuoteSentTransitionToIdstring
A ULID entity identifier for the lead status to transition to after a quote is sent.
afterDocumentSentTransitionToIdstring
A ULID entity identifier for the lead status to transition to after a document is sent.
afterEventScheduledTransitionToIdstring
A ULID entity identifier for the lead status to transition to after an event is scheduled.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create NoteTAVE_CREATE_RESOURCE_NOTEAcción

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

Parámetros de entrada

datestring
Date of the note in YYYY-MM-DD format (in studio timezone)
jobIdstring
ULID identifier of the job to attach the note to
hiddenboolean
Whether the note is hidden from view
authorIdstring
ULID identifier of the author of the note
contactIdstring
ULID identifier of the contact to attach the note to
contentHtmlstringObligatorio
HTML content of the note. This is the main body of the note.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create PaymentTAVE_CREATE_RESOURCE_PAYMENTAcción

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

Parámetros de entrada

memostring
Optional memo or note about the payment
jobIdstringObligatorio
A lowercase ULID entity identifier for the job this payment is associated with
amountintegerObligatorio
Positive numeric representing the payment amount in the studio's currency (in cents/minor units)
hiddenboolean
Whether the payment is hidden
statusstringenum
Status of the payment.
futureconfirmed-futurepostedfailedpending
payerIdstring
A lowercase ULID entity identifier for the payer
authCodestring
Authorization code for the payment transaction
receivedstring
Date when payment was received in YYYY-MM-DD format (in timezone of event or studio)
checkNumberstring
Check number if payment was made by check
invoiceItemIdstring
A lowercase ULID entity identifier for the invoice item
transactionIdstring
Transaction ID from payment processor
paymentMethodIdstring
A lowercase ULID entity identifier for the payment method
paymentAllocationsobject[]
List of payment allocations to specific orders
processedViaClientAccessboolean
Whether the payment was processed via client access

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ProductTAVE_CREATE_RESOURCE_PRODUCTAcción

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

Parámetros de entrada

skustring
Stock Keeping Unit (SKU) for the product.
namestringObligatorio
The name of the product.
priceintegerObligatorio
Positive numeric representing the product price in the studio's currency.
hiddenboolean
Whether or not the product is hidden.
taxableboolean
Whether the product is taxable.
expensesobject[]
Array of product expenses.
vendorIdstring
A ULID entity identifier for the vendor. Can be null.
deliverableboolean
Whether the product is deliverable.
manualEntryboolean
Whether the product allows manual entry.
expenseDueFromstringenum
When the expense is due from.
JobDateBookingNever
descriptionHtmlstring
HTML description of the product.
expenseDuePeriodnumber
Number of periods until expense is due (max 5 digits).
expenseCategoryIdstring
A ULID entity identifier for the expense category. Can be null.
expenseDuePeriodTypestringenum
Period type for expense due date calculation.
DaysWeeksMonths

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Product TypeTAVE_CREATE_RESOURCE_PRODUCT_TYPEAcción

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

Parámetros de entrada

kindstringenum
Kind of product type.
SessionAlbumPrintOtherService
namestringObligatorio
The name of the product type. Required field.
hiddenboolean
Whether or not the product type is hidden. Defaults to false.
parentIdstring
A ULID entity identifier for the parent product type, if this is a sub-category.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Profit CenterTAVE_CREATE_RESOURCE_PROFIT_CENTERAcción

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

Parámetros de entrada

namestringObligatorio
The name of the profit center. Must be between 1 and 24 characters.
hiddenboolean
Whether or not the profit center is hidden. Defaults to false.
externalMappingsobject[]
List of external system mappings for this profit center. These objects cannot be updated currently.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create RestHook SubscriptionTAVE_CREATE_RESOURCE_REST_HOOKAcción

Tool to create a RestHook webhook subscription in Tave. Use when setting up webhook notifications for events like contact creation, job creation, order booking, or payment creation.

Parámetros de entrada

urlstringObligatorio
Webhook callback URL that will receive POST requests when the event occurs
eventstringObligatorioenum
Type of event that will trigger this webhook (contact.created, job.created, order.booked, or payment.created)
contact.createdjob.createdorder.bookedpayment.created
limitToobject
Optional filters to limit which events trigger the webhook.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Tax RateTAVE_CREATE_RESOURCE_TAX_RATEAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create UserTAVE_CREATE_USERAcción

Tool to create a new user in Tave. Use when you need to add a new user account associated with an existing contact from the address book.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Address Book EntryTAVE_DELETE_ADDRESS_BOOK_ENTRYAcción

Tool to delete an entry in the address book. Use when you need to permanently remove an address book entry by its ULID. This operation cannot be undone.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete BrandTAVE_DELETE_BRANDAcción

Tool to delete a brand by its ULID. Use when you need to permanently remove a brand from the system. The API returns a 204 No Content status on successful deletion.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Custom FieldTAVE_DELETE_CUSTOM_FIELDAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Event TypeTAVE_DELETE_EVENT_TYPEAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the event type to delete. Example: '01h35ccwymj5ctckp8px1azhg6'. This action permanently removes the event type.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete GalleryTAVE_DELETE_GALLERYAcción

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

Parámetros de entrada

idstringObligatorio
ULID of the gallery to delete. WARNING: This permanently deletes the gallery. This action cannot be undone.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete DiscountTAVE_DELETE_RESOURCE_DISCOUNTAcción

Tool to delete a specific discount by its ULID. Use when you need to permanently remove a discount from the system. The API returns a 204 No Content status on successful deletion.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Discount TypeTAVE_DELETE_RESOURCE_DISCOUNT_TYPEAcción

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

Parámetros de entrada

idstringObligatorio
ULID of the discount type to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete EventTAVE_DELETE_RESOURCE_EVENTAcción

Tool to delete an event by its ULID identifier. Use when you need to permanently remove an event from the system. This operation cannot be undone.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete JobTAVE_DELETE_RESOURCE_JOBAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the job to delete. Example: '01khbe89198bmv8z0615c2rzv2'. This action permanently removes the job from the system.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Job Closed ReasonTAVE_DELETE_RESOURCE_JOB_CLOSED_REASONAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the job closed reason to delete. Example: '01khbe88gp5yycxgndb848nej0'. This action permanently removes the job closed reason.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Job ContactTAVE_DELETE_RESOURCE_JOB_CONTACTAcción

Tool to delete a job contact by its ULID. Use when you need to permanently remove a job contact from the system. The API returns a 204 No Content status on successful deletion.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Job RoleTAVE_DELETE_RESOURCE_JOB_ROLEAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the job role to delete. Example: '01khbe9106mwgkwvknfme3mgjw'. This action permanently removes the job role from the system.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Job TypeTAVE_DELETE_RESOURCE_JOB_TYPEAcción

Tool to delete a job type by its ULID. Use when you need to permanently remove a job type from the system. The API returns a 204 No Content status on successful deletion.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Lead SourceTAVE_DELETE_RESOURCE_LEAD_SOURCEAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Lead StatusTAVE_DELETE_RESOURCE_LEAD_STATUSAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete NoteTAVE_DELETE_RESOURCE_NOTEAcción

Tool to delete a note by its ULID identifier. Use when you need to remove a note from the system. Note that this performs a soft delete by setting the 'hidden' field to true.

Parámetros de entrada

idstringObligatorio
ULID identifier of the note to delete. This action performs a soft delete by setting the 'hidden' field to true rather than permanently removing the note.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete PaymentTAVE_DELETE_RESOURCE_PAYMENTSAcción

Tool to delete a specific payment by its ULID. Use when you need to permanently remove a payment from the system. The API returns a 204 No Content status on successful deletion.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ProductTAVE_DELETE_RESOURCE_PRODUCTAcción

Tool to delete a specific product by its ULID. Use when you need to permanently remove a product from the system. The API returns a 204 No Content status on successful deletion.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Product TypeTAVE_DELETE_RESOURCE_PRODUCT_TYPEAcción

Tool to delete a specific product type by its ULID. Use when you need to permanently remove a product type from the system. The API returns a 204 No Content status on successful deletion.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Profit CenterTAVE_DELETE_RESOURCE_PROFIT_CENTERAcción

Tool to delete a profit center by its ULID. Use when you need to permanently remove a profit center from the system. The API returns a 204 No Content status on successful deletion.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete RestHookTAVE_DELETE_RESOURCE_REST_HOOKAcción

Tool to unsubscribe from and delete a RestHook webhook subscription by its ULID. Use when you need to permanently remove a webhook registration from the system. The API returns a 204 No Content status on successful deletion.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Tax GroupTAVE_DELETE_RESOURCE_TAX_GROUPAcción

Tool to delete a specific tax group by its ULID. Use when you need to permanently remove a tax group from the system. The API returns a 204 No Content status on successful deletion.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Tax RateTAVE_DELETE_RESOURCE_TAX_RATEAcción

Tool to delete a specific tax rate by its ULID. Use when you need to permanently remove a tax rate from the system. The API returns a 204 No Content status on successful deletion.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete UserTAVE_DELETE_RESOURCE_USERAcción

Tool to delete a user by its ULID. Use when you need to remove a user from the system. The API returns a 204 No Content status on successful deletion.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get BrandTAVE_GET_BRANDAcción

Tool to retrieve a specific brand from Tave by its ULID. Use when you need detailed information about a brand's configuration, including name, contact details, theme settings, and custom domain information.

Parámetros de entrada

idstringObligatorio
ULID identifier of the brand to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get EventTAVE_GET_EVENTAcción

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

Parámetros de entrada

idstringObligatorio
ULID to perform an action on.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Event TypeTAVE_GET_EVENT_TYPEAcción

Tool to retrieve a specific event type by ID. Use when you need to fetch details about a specific event type including its name, color, default settings, and metadata.

Parámetros de entrada

idstringObligatorio
ULID identifier of the event type to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get GalleryTAVE_GET_GALLERYAcción

Tool to retrieve a specific gallery by ID from Tave/VSCO Workspace. Use when you need to fetch details about a gallery including its photos, status, and metadata.

Parámetros de entrada

idstringObligatorio
ULID to perform an action on. The unique identifier of the gallery to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Address Book EntityTAVE_GET_RESOURCE_ADDRESS_BOOKAcción

Tool to fetch a specific Address Book entity by its ULID. Use when you need to retrieve detailed information about a person, company, or location from the address book.

Parámetros de entrada

idstringObligatorio
ULID to perform an action on.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Address Book AddressTAVE_GET_RESOURCE_ADDRESS_BOOK_CAAcción

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

Parámetros de entrada

idstringObligatorio
ULID to perform an action on.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Custom FieldTAVE_GET_RESOURCE_CUSTOM_FIELDAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the custom field to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get DiscountTAVE_GET_RESOURCE_DISCOUNTAcción

Tool to retrieve a specific discount by its ID. Use when you need to get detailed information about a discount including its name, price, type, and other attributes.

Parámetros de entrada

idstringObligatorio
ULID of the discount to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Discount TypeTAVE_GET_RESOURCE_DISCOUNT_TYPEAcción

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

Parámetros de entrada

idstringObligatorio
ULID to perform an action on.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get JobTAVE_GET_RESOURCE_JOBAcción

Tool to fetch a specific job by ID from Tave. Use when you need to retrieve detailed information about a job including its stage, dates, financial data, and associated metadata.

Parámetros de entrada

idstringObligatorio
ULID identifier of the job to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Job Closed ReasonTAVE_GET_RESOURCE_JOB_CLOSED_REASONAcción

Tool to retrieve a specific job closed reason by its ID. Use when you need to get detailed information about a job closed reason including its name, description, and reporting settings.

Parámetros de entrada

idstringObligatorio
ULID identifier of the job closed reason to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Job ContactTAVE_GET_RESOURCE_JOB_CONTACTAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the job contact to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Job RoleTAVE_GET_RESOURCE_JOB_ROLEAcción

Tool to retrieve a specific job role by its ID. Use when you need to get detailed information about a job role including its name, token prefix, kind, and other properties.

Parámetros de entrada

idstringObligatorio
ULID identifier of the job role to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Job TypeTAVE_GET_RESOURCE_JOB_TYPEAcción

Tool to retrieve a specific job type by ID. Use when you need detailed information about a job type including its name, default contacts, default events, and configuration settings.

Parámetros de entrada

idstringObligatorio
ULID identifier of the job type to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Job WorksheetTAVE_GET_RESOURCE_JOB_WORKSHEETAcción

Tool to fetch a Job Worksheet for a specific job by job ID. Use when you need detailed job information including contacts, events, financial data, and workflow details.

Parámetros de entrada

jobIdstringObligatorio
ULID identifier of the job to retrieve the worksheet for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Lead SourceTAVE_GET_RESOURCE_LEAD_SOURCEAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the lead source to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Lead StatusTAVE_GET_RESOURCE_LEAD_STATUSAcción

Tool to retrieve a specific lead status by its ID. Use when you need to get detailed information about a lead status including its transitions and configuration.

Parámetros de entrada

idstringObligatorio
ULID identifier of the lead status to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get My StudioTAVE_GET_RESOURCE_MY_STUDIOAcción

Tool to retrieve information about your studio from Tave. Use when you need to fetch studio configuration settings, including name, currency, date/time formats, and license plan details.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get NoteTAVE_GET_RESOURCE_NOTEAcción

Tool to fetch a specific note by ID from Tave. Use when you need to retrieve detailed information about a note including its content, author, associated entities, and timestamps.

Parámetros de entrada

idstringObligatorio
ULID identifier of the note to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get OrderTAVE_GET_RESOURCE_ORDERAcción

Tool to fetch a specific order by ID from Tave. Use when you need to retrieve detailed information about an order including line items, invoices, payment allocations, tax details, and financial totals.

Parámetros de entrada

idstringObligatorio
ULID identifier of the order to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get PaymentTAVE_GET_RESOURCE_PAYMENTAcción

Tool to fetch a specific payment by ID from Tave. Use when you need to retrieve detailed information about a payment including amount, status, allocations, and refunds.

Parámetros de entrada

idstringObligatorio
ULID identifier of the payment to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Payment MethodTAVE_GET_RESOURCE_PAYMENT_METHODAcción

Tool to retrieve a specific payment method by its ID. Use when you need to get detailed information about a payment method including its name, type, and status.

Parámetros de entrada

idstringObligatorio
ULID identifier of the payment method to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ProductTAVE_GET_RESOURCE_PRODUCTAcción

Tool to retrieve a specific product by its ID. Use when you need to get detailed information about a product including its name, price, SKU, and other attributes.

Parámetros de entrada

idstringObligatorio
ULID identifier of the product to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Product TypeTAVE_GET_RESOURCE_PRODUCT_TYPEAcción

Tool to retrieve a specific product type by its ID. Use when you need to get detailed information about a product type including its name, kind, and visibility settings.

Parámetros de entrada

idstringObligatorio
ULID identifier of the product type to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Profit CenterTAVE_GET_RESOURCE_PROFIT_CENTERAcción

Tool to retrieve a specific profit center by its ID. Use when you need to get detailed information about a profit center for tracking revenue and expenses.

Parámetros de entrada

idstringObligatorio
ULID identifier of the profit center to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Tax RateTAVE_GET_RESOURCE_TAX_RATEAcción

Tool to retrieve a specific tax rate by its ULID. Use when you need detailed information about a tax rate including its name, rate percentage, and whether it is inclusive.

Parámetros de entrada

idstringObligatorio
ULID identifier of the tax rate to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TimezoneTAVE_GET_RESOURCE_TIMEZONEAcción

Tool to retrieve a specific timezone by its ULID from Tave. Use when you need to fetch timezone details including the timezone name, display name, codes, region, and location information.

Parámetros de entrada

idstringObligatorio
ULID identifier of the timezone to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User by IDTAVE_GET_RESOURCE_USERAcción

Tool to retrieve a specific user by their ULID identifier. Use when you need to get detailed information about a user including their contact ID, username, permissions, and timestamps.

Parámetros de entrada

idstringObligatorio
ULID to perform an action on. A lowercase ULID entity identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Address Book ContactsTAVE_LIST_ADDRESS_BOOKAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List BrandsTAVE_LIST_BRANDSAcción

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

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeHiddenboolean
Include objects that have been hidden
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Discount TypesTAVE_LIST_DISCOUNT_TYPESAcción

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

Parámetros de entrada

sortBystring
Sort items in the collection by the given property. Default is 'id'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Studio EventsTAVE_LIST_EVENTSAcción

Tool to list a studio's events from Tave. Use when you need to retrieve events with optional filtering by job, external mapping ID, or visibility status.

Parámetros de entrada

pageinteger
The page of results to return.
jobIdstring
Include objects attached to a job
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeHiddenboolean
Include objects that have been hidden
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Event TypesTAVE_LIST_EVENT_TYPESAcción

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

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeHiddenboolean
Include objects that have been hidden
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List FilesTAVE_LIST_FILESAcción

Tool to list files in Tave. Use when you need to retrieve files associated with jobs or contacts. Supports pagination and filtering by job, contact, or external mapping ID.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource Custom FieldsTAVE_LIST_RESOURCE_CUSTOM_FIELDAcción

Tool to list custom fields configured on a studio. Use when you need to retrieve all custom fields or filter them by resource type (contact/job) or kind.

Parámetros de entrada

kindstring[]
Filter custom fields by their kind/type (e.g., textfield, textbox, number, money, checkbox, date, decimal, dropdown, time).
sortBystring
Sort items in the collection by the given property (e.g., id, name, created, modified).
canApplyTostringenum
Enum for resource types that custom fields can apply to.
contactjob

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource DiscountTAVE_LIST_RESOURCE_DISCOUNTAcción

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

Parámetros de entrada

sortBystring
Sort items in the collection by the given property.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List GalleriesTAVE_LIST_RESOURCE_GALLERYAcción

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

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeHiddenboolean
Include objects that have been hidden
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource JobTAVE_LIST_RESOURCE_JOBAcción

Tool to list jobs of a studio. Use when you need to retrieve all jobs for the studio account, with optional filtering by closed status or external mapping ID.

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeClosedboolean
Include jobs that have been closed
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Job Closed ReasonsTAVE_LIST_RESOURCE_JOB_CLOSED_REASONAcción

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

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeHiddenboolean
Include objects that have been hidden
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource Job ContactTAVE_LIST_RESOURCE_JOB_CONTACTAcción

Tool to list a job's contacts. Use when you need to retrieve contacts associated with jobs, with optional filtering by contact ID, job ID, or external mapping ID.

Parámetros de entrada

pageinteger
The page of results to return.
jobIdstring
Include objects attached to a job
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
contactIdstring
A ULID entity identifier that is nullable.
includeHiddenboolean
Include objects that have been hidden
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource Job OrdersTAVE_LIST_RESOURCE_JOB_ORDERSAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Job PaymentsTAVE_LIST_RESOURCE_JOB_PAYMENTAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Job RolesTAVE_LIST_RESOURCE_JOB_ROLEAcción

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

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeHiddenboolean
Include objects that have been hidden
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource Job TypeTAVE_LIST_RESOURCE_JOB_TYPEAcción

Tool to list job types of a studio. Use when you need to retrieve all available job types for the studio account, with optional filtering by hidden status or external mapping ID.

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeHiddenboolean
Include objects that have been hidden
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource Lead SourceTAVE_LIST_RESOURCE_LEAD_SOURCEAcción

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

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeHiddenboolean
Include objects that have been hidden
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource Lead StatusTAVE_LIST_RESOURCE_LEAD_STATUSAcción

Tool to list lead statuses of a studio. Use when you need to retrieve all lead statuses for tracking the state of leads in the sales pipeline.

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeHiddenboolean
Include objects that have been hidden
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource NoteTAVE_LIST_RESOURCE_NOTEAcción

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

Parámetros de entrada

pageinteger
The page of results to return.
jobIdstring
Include objects attached to a job
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeHiddenboolean
Include objects that have been hidden
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource OrderTAVE_LIST_RESOURCE_ORDERAcción

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

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource PaymentTAVE_LIST_RESOURCE_PAYMENTAcción

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

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource Payment MethodTAVE_LIST_RESOURCE_PAYMENT_METHODAcción

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

Parámetros de entrada

sortBystring
Sort items in the collection by the given property.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource ProductTAVE_LIST_RESOURCE_PRODUCTAcción

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

Parámetros de entrada

sortBystring
Sort items in the collection by the given property.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Product TypesTAVE_LIST_RESOURCE_PRODUCT_TYPEAcción

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

Parámetros de entrada

sortBystring
Sort items in the collection by the given property.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource Profit CenterTAVE_LIST_RESOURCE_PROFIT_CENTERAcción

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

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeHiddenboolean
Include objects that have been hidden
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List REST HooksTAVE_LIST_RESOURCE_REST_HOOKAcción

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

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeHiddenboolean
Include objects that have been hidden

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource Tax GroupsTAVE_LIST_RESOURCE_TAX_GROUPSAcción

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

Parámetros de entrada

sortBystring
Sort items in the collection by the given property.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource Tax RatesTAVE_LIST_RESOURCE_TAX_RATESAcción

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

Parámetros de entrada

sortBystring
Sort items in the collection by the given property.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource TimezoneTAVE_LIST_RESOURCE_TIMEZONEAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource UserTAVE_LIST_RESOURCE_USERAcción

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

Parámetros de entrada

pageinteger
The page of results to return.
sortBystring
Sort items in the collection by the given property.
pageSizeinteger
Number of results per page to return in the collection.
includeHiddenboolean
Include objects that have been hidden
externalMappingIdstring
Filter objects by an external id for this provider.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Address Book EntryTAVE_UPDATE_ADDRESS_BOOKAcción

Tool to update a specific entry in the Tave address book. Use when you need to modify contact information, change entry type, or update any fields for an existing address book entry.

Parámetros de entrada

idstringObligatorio
ULID of the address book entry to update
faxobject
Phone number object
urlstring
Website URL
kindstringObligatorioenum
Type of address book entry: person, company, or location
personcompanylocation
emailstring
Primary email address
genderstring
Gender
hiddenboolean
Whether the entry is hidden from default views
pinnedboolean
Whether the entry is pinned for quick access
addressstring
Physical address
brandIdstring
Associated brand ID
jobTitlestring
Job title
lastNamestring
Last name (typically used for person kind)
birthdatestring
Birth date
cellPhoneobject
Phone number object
firstNamestring
First name (typically used for person kind)
homePhoneobject
Phone number object
workPhoneobject
Phone number object
maidenNamestring
Maiden name
salutationstring
Salutation or title
anniversarystring
Anniversary date
companyNamestring
Company name (typically used for company kind)
privacyOptInboolean
Privacy opt-in status for communications
mailingAddressstring
Mailing address if different from physical address
previousClientboolean
Whether this contact is a previous client
secondaryEmailstring
Secondary email address
twitterUsernamestring
Twitter username
facebookUsernamestring
Facebook username
requireStrictPrivacyboolean
Whether strict privacy requirements apply to this contact

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update BrandTAVE_UPDATE_BRANDAcción

Tool to update a specific brand in Tave. Use when you need to modify brand settings such as name, alias, contact information, theme, or domain configuration.

Parámetros de entrada

idstringObligatorio
ULID identifier of the brand to update
bccstring
BCC email address for brand communications
namestring
The brand's name (4-128 characters)
aliasstring
Brand alias (4-32 characters)
themeobject
Theme configuration for the brand.
hiddenboolean
Whether the brand is hidden
phone1object
Phone number configuration for the brand.
phone2object
Phone number configuration for the brand.
phone3object
Phone number configuration for the brand.
replyTostring
Reply-to email address for brand communications
forwardTostring
Forward-to email address for brand communications
shortNamestring
Shorter name for the brand to be used in constrained UI places (4-128 characters)
locationIdstring
ULID of the associated location
officeHoursstring
Office hours for the brand
customDomainstring
Custom domain for the brand
externalMappingsobject[]
External system mappings for the brand
enableProfileEditboolean
Whether to enable profile editing
googleAnalyticsIdstring
Google Analytics tracking ID (format: UA-XXXXXX-X, YT-XXXXXX-X, or MO-XXXXXX-X)
rootContactFormIdstring
ULID of the root contact form
customDomainStatusstringenum
Status of the custom domain configuration.
activependingdns-failedssl-failed
clientAccessVersioninteger
Client access version (1-10)
showHistoryInPortalboolean
Whether to show history in the client portal
breakoutPackagePricingboolean
Whether to break out package pricing

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Event TypeTAVE_UPDATE_EVENT_TYPEAcción

Tool to update an existing event type in Tave. Use when you need to modify event type properties like name, color, duration, or classification. Requires the event type ID and at least the required fields (name and tokenPrefix).

Parámetros de entrada

idstringObligatorio
ULID identifier of the event type to update
kindstringenum
Event type kind options.
callmeetingothersession
namestringObligatorio
Name of the event type (1-24 characters)
colorstring
Hex color code for the event type (6 characters, lowercase hex)
hiddenboolean
Whether the event type is hidden from view
tokenPrefixstringObligatorio
Unique prefix identifier for placeholders (lowercase alphanumeric and underscores only). Cannot use reserved prefixes: booked_order, brand, clients, contract, custom, customers, event, invoice, item, job, quote, order, payment, payment_schedule, primary_session, recipient, subjects, tave, team, vendors
sortPositioninteger
Sort position for ordering event types (0-65535)
defaultDurationinteger
Default duration for events of this type in minutes (5-86400)
defaultAttendeesstring[]
List of default attendee token prefixes (lowercase alphanumeric and underscores, 1-32 chars each)
externalMappingsobject[]
External system mappings for this event type
defaultLocationIdstring
ULID of the default location for this event type

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Custom FieldTAVE_UPDATE_RESOURCE_CUSTOM_FIELDAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the custom field to update
kindstringenum
Enum for the kind of custom field.
TextFieldTextBoxDropDownNumberDecimalMoneyDateTimeCheckbox
namestring
Name of the custom field (max 255 characters)
tokenstring
Token identifier for the custom field (max 128 characters)
hiddenboolean
Whether the custom field is hidden
choicesstring[]
List of choices for DropDown kind custom fields
can_apply_tostringenum
Enum for the type of resource the custom field can apply to.
JobContact
client_labelstring
Label displayed to clients (max 255 characters)
client_accessstringenum
Enum for the client access level of the custom field.
NoneVisibleEditable

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update EventTAVE_UPDATE_RESOURCE_EVENTAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the event to update
namestring
Name of the event
jobIdstring
ULID identifier of the associated job
allDayboolean
Whether the event is all-day
hiddenboolean
Whether the event is hidden from view
typeIdstring
ULID identifier of the event type
channelstringenum
Event channel type.
InPersonPhoneVirtual
endDatestring
End date in YYYY-MM-DD format
endTimestring
End time in 24-hour format (HH:MM:SS)
locationobject
Event location details.
confirmedboolean
Whether the event is confirmed
galleryIdstring
ULID identifier of the associated gallery
startDatestring
Start date in YYYY-MM-DD format
startTimestring
Start time in 24-hour format (HH:MM:SS)
timezoneIdstring
ULID identifier of the timezone
virtualUrlstring
URL for virtual events
phoneNumberobject
Phone number representation.
timezoneNamestring
Timezone name (ignored if timezoneId is provided)
descriptionHtmlstring
HTML description of the event
externalMappingsobject[]
External system mappings

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update GalleryTAVE_UPDATE_RESOURCE_GALLERYAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the gallery to update.
namestringObligatorio
The name of this gallery. Required for PUT updates.
slugstring
The URL path slug for this gallery. Must contain only letters, numbers, dashes, and underscores. Will be converted to lowercase.
jobIdstring
A ULID entity identifier for the job this gallery is associated with.
hiddenboolean
Whether this gallery is hidden.
publicboolean
Whether this gallery is publicly accessible.
statusstringenum
Status of a gallery.
pre-releaseactiveinactivearchived
eventIdstring
A ULID entity identifier for the event this gallery is associated with.
adminUrlstringObligatorio
The internal URL of this gallery in the remote admin portal. May be used to link employees to the gallery administration interface in the remote service. Required for PUT updates.
categorystring
The category of this gallery. Galleries may be grouped by this category text in future client portal designs.
headlinestring
The headline of this gallery. Prioritized over name when displayed to the user.
passwordstring
A reusable plain-text passcode for unlocking the gallery. This pass code may be given to invited users.
remoteIdstringObligatorio
The remote ID of this gallery. This value must be unique for the studio. Required for PUT updates.
clientUrlstringObligatorio
The URL of this gallery. Will be used for links in emails and the client portal. Required for PUT updates.
eventDatestring
The date of the event this gallery is for in YYYY-MM-DD format. Useful in automations or email tokens.
coverPhotoobject
Cover photo details for a gallery.
releaseDatestring
The date this gallery will be released to the public in YYYY-MM-DD format. Useful in automations or email tokens.
orderDueDatestring
The date that orders for this gallery are due by in YYYY-MM-DD format. Useful in automations or email tokens.
remoteCreatedstringObligatorio
The creation date and time of this gallery in UTC (ISO 8601 format). Required for PUT updates.
expirationDatestring
The date this gallery will expire and no longer be accessible in YYYY-MM-DD format. Useful in automations or email tokens.
externalMappingsobject[]
External mappings to relate this gallery to entities in external systems.
requiresPasswordboolean
Whether this gallery requires a password for access.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update JobTAVE_UPDATE_RESOURCE_JOBAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the job to update
namestring
Name of the job that will override the auto-generated title
stagestringenum
Stage of the job in the workflow.
leadbookedfulfillmentcompleted
closedboolean
Whether the lead or job is closed
pinnedboolean
Whether the job is favorited/pinned
sampleboolean
Whether the lead or job is a sample job
brandIdstring
ULID identifier of the brand
webLeadboolean
Whether the lead or job came from a contact form
eventDatestring
Event date in YYYY-MM-DD format (in studio timezone)
jobTypeIdstring
ULID identifier of the job type
leadNotesstring
Notes about the lead
closedDatestring
Date when the job was closed in YYYY-MM-DD format (in studio timezone)
guestCountinteger
Number of guests for the event
leadRatinginteger
Rating for the lead (1-5)
workflowIdstring
ULID identifier of the workflow
bookingDatestring
Booking date in YYYY-MM-DD format (in studio timezone)
inquiryDatestring
Inquiry date in YYYY-MM-DD format (in studio timezone)
customFieldsobject[]
List of custom field values for the job
customNumberstring
Custom job number or identifier
leadSourceIdstring
ULID identifier of the lead source
leadStatusIdstring
ULID identifier of the lead status
completedDatestring
Completion date in YYYY-MM-DD format (in studio timezone)
contactFormIdstring
ULID identifier of the contact form
leadMaxBudgetinteger
Maximum budget for the lead in the studio's currency
closedReasonIdstring
ULID identifier of the closed reason
leadConfidencestringenum
Confidence level for a lead.
lowmediumhigh
fulfillmentDatestring
Fulfillment date in YYYY-MM-DD format (in studio timezone)
externalMappingsobject[]
List of external system mappings
leadDecisionExpectedByDatestring
Expected decision date for the lead in YYYY-MM-DD format (in studio timezone)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Job Closed ReasonTAVE_UPDATE_RESOURCE_JOB_CLOSED_REASONAcción

Tool to update a job closed reason in Tave. Use when you need to modify the name, description, visibility, or reporting settings of a job closed reason.

Parámetros de entrada

idstringObligatorio
ULID identifier of the job closed reason to update
namestringObligatorio
Name of the job closed reason (1-32 characters)
hiddenboolean
Whether the job closed reason is hidden from view
descriptionstring
Optional description of the job closed reason (max 64 characters)
externalMappingsobject[]
External system mappings for this job closed reason
includedInReportingboolean
Whether this reason should be included in reporting

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Job ContactTAVE_UPDATE_RESOURCE_JOB_CONTACTAcción

Tool to update a specific job contact in Tave. Use when modifying contact associations with jobs, changing client status, or updating job roles for a contact.

Parámetros de entrada

idstringObligatorio
ULID identifier of the job contact to update
jobIdstringObligatorio
ULID identifier of the job
clientboolean
Whether this contact is the primary client for the job
hiddenboolean
Whether the job contact is hidden from view
jobRolesarray
List of job role ULID identifiers associated with this contact
contactIdstringObligatorio
ULID identifier of the contact
roleKindsstring[]
List of role kinds for this job contact (client, customer, team, subject, vendor)
externalMappingsobject[]
External system mappings for this job contact

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Job RoleTAVE_UPDATE_RESOURCE_JOB_ROLEAcción

Tool to update a job role in Tave. Use when you need to modify the name, token prefix, kind, visibility, or sort position of a job role.

Parámetros de entrada

idstringObligatorio
ULID identifier of the job role to update
kindstringenum
Type/kind of the job role
customersubjectteamvendor
namestringObligatorio
Name of the job role (1-24 characters)
hiddenboolean
Whether the job role is hidden from view
tokenPrefixstringObligatorio
The prefix identifier for placeholders (must be unique across all job roles). Reserved prefixes that cannot be used: booked_order, brand, clients, contract, custom, customers, event, invoice, item, job, quote, order, payment, payment_schedule, primary_session, recipient, subjects, tave, team, vendors
sortPositioninteger
Sort position for ordering job roles (0-65535)
externalMappingsobject[]
External system mappings for this job role

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Job TypeTAVE_UPDATE_RESOURCE_JOB_TYPEAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the job type to update
namestringObligatorio
The name of this job type
hiddenboolean
Whether or not the job type is hidden
workflowIdstring
ULID identifier of the workflow for this job type
sortPositioninteger
Sort position for ordering job types (0-65535)
defaultEventsobject[]
List of default event types to associate with this job type
profitCenterIdstring
ULID identifier of the profit center for this job type
defaultContactsobject[]
List of default job roles to associate with this job type
externalMappingsobject[]
List of external system mappings for this job type
initialLeadStatusIdstring
ULID identifier of the initial lead status for this job type
primarySessionRequiredboolean
Whether a primary session is required for jobs of this type

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Lead SourceTAVE_UPDATE_RESOURCE_LEAD_SOURCEAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Lead StatusTAVE_UPDATE_RESOURCE_LEAD_STATUSAcción

Tool to update a specific lead status in Tave. Use when you need to modify lead status properties such as name, color, sort position, or automated transition rules.

Parámetros de entrada

idstringObligatorio
ULID identifier of the lead status to update
kindstringenum
Enum for lead status kind values.
generalnewstale
namestring
The name of the lead status. Must be between 1 and 64 characters.
colorstring
Hex color code for the lead status (6 characters, lowercase hex). Example: '278639' for green.
hiddenboolean
Whether or not the lead status is hidden.
sortPositioninteger
Sort position for ordering lead statuses. Must be between 0 and 65535.
transitionToIdstring
ULID of the lead status to transition to automatically based on time interval.
externalMappingsobject[]
List of external system mappings for this lead status.
transitionIntervalinteger
Time interval for automatic transition. Must be between 0 and 99999999999.
transitionIntervalUnitstringenum
Enum for transition interval unit values.
dayweekmonthyear
transitionClosedReasonIdstring
ULID of the closed reason to use when transitioning to a closed status.
afterFormSentTransitionToIdstring
ULID of the lead status to transition to after a form is sent.
afterEmailSentTransitionToIdstring
ULID of the lead status to transition to after an email is sent.
afterQuoteSentTransitionToIdstring
ULID of the lead status to transition to after a quote is sent.
afterDocumentSentTransitionToIdstring
ULID of the lead status to transition to after a document is sent.
afterEventScheduledTransitionToIdstring
ULID of the lead status to transition to after an event is scheduled.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update NoteTAVE_UPDATE_RESOURCE_NOTEAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update OrderTAVE_UPDATE_RESOURCE_ORDERAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the order to update
namestring
Custom name for the order
titlestring
Name or auto-generated title of the order
hiddenboolean
Whether the order is hidden
statusstringenum
Status of the order.
draftopenpaid-in-fullcompletedvoided
dueDatestring
Due date for the order in YYYY-MM-DD format
bookedOnstring
Date when the order was booked in YYYY-MM-DD format
lineItemsobject[]
List of line items for the order
taxGroupIdstring
ULID identifier of the tax group for calculating taxes
recipientIdstring
ULID identifier of the recipient from the address book
customNumberstring
Custom order number or identifier (max 16 characters)
referenceCodestring
Reference code for the order (max 11 characters)
paymentTermsIdstring
ULID identifier of the payment terms
preTaxDiscountobject
Discount applied to an order.
bookedFromQuoteboolean
Whether the order was booked from a quote
afterTaxDiscountobject
Discount applied to an order.
taxIsCompoundingboolean
Whether taxes are compounded (tax the tax)
bookedElectronicallyboolean
Whether the order was booked electronically

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Profit CenterTAVE_UPDATE_RESOURCE_PROFIT_CENTERAcción

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

Parámetros de entrada

idstringObligatorio
ULID identifier of the profit center to update
namestring
The name of the profit center. Must be between 1 and 24 characters.
hiddenboolean
Whether or not the profit center is hidden.
externalMappingsobject[]
List of external system mappings for this profit center. These objects cannot be updated currently.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Tax GroupTAVE_UPDATE_RESOURCE_TAX_GROUPAcción

Tool to update a specific tax group in Tave. Use when you need to modify tax group properties like name, compounding settings, default status, or associated tax rates.

Parámetros de entrada

idstringObligatorio
ULID identifier of the tax group to update
namestring
Name of the tax group (max 64 characters)
hiddenboolean
Whether the tax group is hidden
defaultboolean
Whether this is the default tax group
taxRatesobject[]
List of tax rates associated with this tax group (max 3 items)
compoundingboolean
Whether the tax group uses compounding (taxes applied sequentially)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Tax RateTAVE_UPDATE_RESOURCE_TAX_RATEAcción

Tool to update a specific tax rate in Tave. Use when you need to modify tax rate properties such as name, rate percentage, or inclusive/exclusive status.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update UserTAVE_UPDATE_RESOURCE_USERAcción

Tool to update a specific user in Tave. Use when you need to modify user properties such as contact association, beta access, admin status, or visibility.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Studio Readonly ModeTAVE_UPDATE_STUDIO_READONLY_MODEAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not