# Tave

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

- **Category:** crm
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 129
- **Triggers:** 0
- **Slug:** `TAVE`
- **Version:** 00000000_00

## Tools

### Apply Payment to Order

**Slug:** `TAVE_APPLY_PAYMENT_TO_ORDER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the payment to apply. This is the unique identifier of the payment that will be applied to the order. |
| `amount` | integer | Yes | Positive numeric representing an amount in the studio's currency. The amount of the payment to apply to the order. |
| `orderId` | string | Yes | ULID of the order to apply the payment to. This is the unique identifier of the order that will receive the payment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Brand

**Slug:** `TAVE_CREATE_BRAND`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Custom Field

**Slug:** `TAVE_CREATE_CUSTOM_FIELD`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Discount Type

**Slug:** `TAVE_CREATE_DISCOUNT_TYPE`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Gallery

**Slug:** `TAVE_CREATE_GALLERY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of this gallery. |
| `slug` | string | No | The URL path slug for this gallery. Must contain only letters, numbers, dashes, and underscores. Will be converted to lowercase. |
| `jobId` | string | No | A ULID entity identifier for the job this gallery is associated with. |
| `hidden` | boolean | No | Whether this gallery is hidden. |
| `public` | boolean | No | Whether this gallery is publicly accessible. |
| `eventId` | string | No | A ULID entity identifier for the event this gallery is associated with. |
| `adminUrl` | string | Yes | 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. |
| `category` | string | No | The category of this gallery. Galleries may be grouped by this category text in future client portal designs. |
| `headline` | string | No | The headline of this gallery. Prioritized over name when displayed to the user. |
| `password` | string | No | A reusable plain-text passcode for unlocking the gallery. This pass code may be given to invited users. |
| `remoteId` | string | Yes | The remote ID of this gallery. This value must be unique for the studio. |
| `clientUrl` | string | Yes | The URL of this gallery. Will be used for links in emails and the client portal. |
| `eventDate` | string | No | The date of the event this gallery is for in YYYY-MM-DD format. Useful in automations or email tokens. |
| `coverPhoto` | object | No | Cover photo details for a gallery. |
| `releaseDate` | string | No | The date this gallery will be released to the public in YYYY-MM-DD format. Useful in automations or email tokens. |
| `orderDueDate` | string | No | The date that orders for this gallery are due by in YYYY-MM-DD format. Useful in automations or email tokens. |
| `remoteCreated` | string | Yes | The creation date and time of this gallery in UTC (ISO 8601 format). |
| `expirationDate` | string | No | The date this gallery will expire and no longer be accessible in YYYY-MM-DD format. Useful in automations or email tokens. |
| `externalMappings` | array | No | External mappings to relate this gallery to entities in external systems. |
| `requiresPassword` | boolean | No | Whether this gallery requires a password for access. Defaults to true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Address Book Entry

**Slug:** `TAVE_CREATE_RESOURCE_ADDRESS_BOOK`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kind` | string ("person" | "company" | "location") | Yes | Type of address book entry. Valid values: 'person', 'company', 'location' |
| `email` | string | No | Email address of the contact |
| `lastName` | string | No | Last name of the person (for kind='person') |
| `firstName` | string | No | First name of the person (for kind='person') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Discount

**Slug:** `TAVE_CREATE_RESOURCE_DISCOUNT`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Event

**Slug:** `TAVE_CREATE_RESOURCE_EVENT`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Event Type

**Slug:** `TAVE_CREATE_RESOURCE_EVENT_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kind` | string | No | Type of event. Must be one of: call, meeting, other, session. Defaults to 'meeting' |
| `name` | string | Yes | Name of the event type (1-24 characters) |
| `color` | string | No | Hex color code for the event type (6 characters, without # prefix) |
| `hidden` | boolean | No | Whether the event type is hidden |
| `tokenPrefix` | string | Yes | 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 |
| `sortPosition` | integer | No | Sort position for ordering event types (0-65535). Defaults to 100 |
| `defaultDuration` | integer | No | Default duration in minutes (5-86400). Defaults to 60 |
| `defaultAttendees` | array | No | List of default attendee identifiers (1-32 characters each, lowercase alphanumeric and underscores only) |
| `externalMappings` | array | No | External system mappings for this event type |
| `defaultLocationId` | string | No | ULID of the default location for this event type |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create File

**Slug:** `TAVE_CREATE_RESOURCE_FILE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Display name for the file (if different from filename) |
| `hidden` | boolean | No | Whether the file should be hidden |
| `typeId` | string | No | ULID identifier of the file type |
| `filename` | string | Yes | Name of the file to create (required) |
| `mimeType` | string | No | MIME type of the file (e.g., 'text/plain', 'application/pdf', 'image/png') |
| `remoteUrl` | string | No | URL to a remote file location instead of providing binaryData |
| `attachedTo` | array | No | List of entities this file is attached to |
| `binaryData` | string | No | Base64-encoded binary data of the file. Maximum size is 20MB. |
| `description` | string | No | Description of the file |
| `imageMetaData` | object | No | Metadata for image files |
| `externalMappings` | array | No | List of external system mappings for this file |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Job

**Slug:** `TAVE_CREATE_RESOURCE_JOB`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the job that will override the auto-generated title |
| `stage` | string ("lead" | "booked" | "fulfillment" | "completed") | Yes | Stage that the job is in (lead, booked, fulfillment, or completed) |
| `closed` | boolean | No | Whether the lead or job is closed |
| `pinned` | boolean | No | Whether the job is favorited/pinned |
| `sample` | boolean | No | Whether the lead or job is a sample job |
| `brandId` | string | No | ULID identifier of the brand |
| `webLead` | boolean | No | Whether the lead or job came from a contact form |
| `eventDate` | string | No | Event date in YYYY-MM-DD format (in studio timezone) |
| `jobTypeId` | string | No | ULID identifier of the job type |
| `leadNotes` | string | No | Notes about the lead |
| `closedDate` | string | No | Date when the job was closed in YYYY-MM-DD format (in studio timezone) |
| `guestCount` | integer | No | Number of guests for the event |
| `leadRating` | integer | No | Rating for the lead (1-5) |
| `workflowId` | string | No | ULID identifier of the workflow |
| `bookingDate` | string | No | Booking date in YYYY-MM-DD format (in studio timezone) |
| `inquiryDate` | string | No | Inquiry date in YYYY-MM-DD format (in studio timezone) |
| `customFields` | array | No | List of custom field values for the job |
| `customNumber` | string | No | Custom job number or identifier |
| `leadSourceId` | string | No | ULID identifier of the lead source |
| `leadStatusId` | string | No | ULID identifier of the lead status |
| `completedDate` | string | No | Completion date in YYYY-MM-DD format (in studio timezone) |
| `contactFormId` | string | No | ULID identifier of the contact form |
| `leadMaxBudget` | integer | No | Maximum budget for the lead in the studio's currency |
| `closedReasonId` | string | No | ULID identifier of the closed reason |
| `leadConfidence` | string ("low" | "medium" | "high") | No | Confidence level for a lead. |
| `fulfillmentDate` | string | No | Fulfillment date in YYYY-MM-DD format (in studio timezone) |
| `externalMappings` | array | No | List of external system mappings |
| `leadDecisionExpectedByDate` | string | No | Expected decision date for the lead in YYYY-MM-DD format (in studio timezone) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Job Closed Reason

**Slug:** `TAVE_CREATE_RESOURCE_JOB_CLOSED_REASON`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the job closed reason (required, 1-32 characters) |
| `hidden` | boolean | No | Whether the job closed reason is hidden |
| `description` | string | No | Description of the job closed reason (max 64 characters) |
| `externalMappings` | array | No | List of external system mappings for this job closed reason |
| `includedInReporting` | boolean | No | Whether this reason should be included in reporting |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Job Contact

**Slug:** `TAVE_CREATE_RESOURCE_JOB_CONTACT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jobId` | string | Yes | A lowercase ULID entity identifier for the job |
| `client` | boolean | No | Whether the contact is marked as a client. Defaults to false. |
| `hidden` | boolean | No | Whether or not the object is hidden |
| `jobRoles` | array | No | List of ULID entity identifiers for job roles assigned to this contact |
| `contactId` | string | Yes | A lowercase ULID entity identifier for the contact |
| `roleKinds` | array | No | List of role kinds (client, customer, team, subject, vendor) for the contact |
| `externalMappings` | array | No | Mappings to external system entities. These objects cannot be updated currently. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Job Order

**Slug:** `TAVE_CREATE_RESOURCE_JOB_ORDER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Custom name for the order |
| `jobId` | string | Yes | ULID identifier of the job to create the order on |
| `title` | string | No | Name or auto-generated title of the order |
| `hidden` | boolean | No | Whether the order is hidden |
| `status` | string ("draft" | "open" | "paid-in-full" | "completed" | "voided") | No | Status of the order. |
| `dueDate` | string | No | Due date for the order in YYYY-MM-DD format |
| `bookedOn` | string | No | Date when the order was booked in YYYY-MM-DD format |
| `lineItems` | array | No | List of line items for the order |
| `taxGroupId` | string | No | ULID identifier of the tax group for calculating taxes |
| `recipientId` | string | No | ULID identifier of the recipient from the address book |
| `customNumber` | string | No | Custom order number or identifier |
| `paymentTermsId` | string | No | ULID identifier of the payment terms |
| `preTaxDiscount` | object | No | Discount applied to an order. |
| `bookedFromQuote` | boolean | No | Whether the order was booked from a quote |
| `afterTaxDiscount` | object | No | Discount applied to an order. |
| `bookedElectronically` | boolean | No | Whether the order was booked electronically |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Job Role

**Slug:** `TAVE_CREATE_RESOURCE_JOB_ROLE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kind` | string ("customer" | "subject" | "team" | "vendor") | No | Kind of job role entity. |
| `name` | string | Yes | Name of the job role (1-24 characters) |
| `hidden` | boolean | No | Whether the job role is hidden |
| `tokenPrefix` | string | Yes | 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 |
| `sortPosition` | integer | No | Sort position for ordering job roles (0-65535). Defaults to 100 if not specified. |
| `externalMappings` | array | No | List of external system mappings (cannot be updated after creation) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Job Type

**Slug:** `TAVE_CREATE_RESOURCE_JOB_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of this job type |
| `hidden` | boolean | No | Whether or not the job type is hidden |
| `workflowId` | string | No | ULID identifier of the workflow for this job type |
| `sortPosition` | integer | No | Sort position for ordering job types (0-65535). Defaults to 100 |
| `defaultEvents` | array | No | List of default event types to associate with this job type |
| `profitCenterId` | string | No | ULID identifier of the profit center for this job type |
| `defaultContacts` | array | No | List of default job roles to associate with this job type |
| `externalMappings` | array | No | List of external system mappings for this job type |
| `initialLeadStatusId` | string | No | ULID identifier of the initial lead status for this job type |
| `primarySessionRequired` | boolean | No | Whether a primary session is required for jobs of this type. Defaults to true |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Job Worksheet

**Slug:** `TAVE_CREATE_RESOURCE_JOB_WORKSHEET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the job that will override the auto-generated title |
| `title` | string | Yes | Title for the job |
| `closed` | boolean | No | Whether the lead or job is closed |
| `events` | array | No | List of events associated with this job |
| `pinned` | boolean | No | Whether the job is favorited/pinned |
| `sample` | boolean | No | Whether the lead or job is a sample job |
| `brandId` | string | No | ULID identifier of the brand |
| `webLead` | boolean | No | Whether the lead or job came from a contact form |
| `contacts` | array | No | List of contacts associated with this job |
| `eventDate` | string | No | Event date in YYYY-MM-DD format (in studio timezone) |
| `jobTypeId` | string | No | ULID identifier of the job type |
| `leadNotes` | string | No | Notes about the lead |
| `closedDate` | string | No | Date when the job was closed in YYYY-MM-DD format (in studio timezone) |
| `guestCount` | integer | No | Number of guests for the event |
| `leadRating` | integer | No | Rating for the lead (1-5) |
| `workflowId` | string | No | ULID identifier of the workflow |
| `bookingDate` | string | No | Booking date in YYYY-MM-DD format (in studio timezone) |
| `inquiryDate` | string | No | Inquiry date in YYYY-MM-DD format (in studio timezone) |
| `customFields` | array | No | List of custom field values for the job |
| `customNumber` | string | No | Custom job number or identifier |
| `leadSourceId` | string | No | ULID identifier of the lead source |
| `leadStatusId` | string | No | ULID identifier of the lead status |
| `completedDate` | string | No | Completion date in YYYY-MM-DD format (in studio timezone) |
| `contactFormId` | string | No | ULID identifier of the contact form |
| `leadMaxBudget` | integer | No | Maximum budget for the lead in the studio's currency |
| `closedReasonId` | string | No | ULID identifier of the closed reason |
| `leadConfidence` | string ("low" | "medium" | "high") | No | Confidence level for a lead. |
| `fulfillmentDate` | string | No | Fulfillment date in YYYY-MM-DD format (in studio timezone) |
| `externalMappings` | array | No | List of external system mappings |
| `leadDecisionExpectedByDate` | string | No | Expected decision date for the lead in YYYY-MM-DD format (in studio timezone) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Lead Source

**Slug:** `TAVE_CREATE_RESOURCE_LEAD_SOURCE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the lead source. Must be between 3 and 128 characters. |
| `hidden` | boolean | No | Whether or not the lead source is hidden. Defaults to false. |
| `parentId` | string | No | A ULID entity identifier for the parent lead source, if this is a nested/child lead source. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Lead Status

**Slug:** `TAVE_CREATE_RESOURCE_LEAD_STATUS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kind` | string ("general" | "new" | "stale") | No | Kind of lead status. |
| `name` | string | Yes | The name of the lead status. Must be between 1 and 64 characters. |
| `color` | string | No | Hex color code (6 characters) for the lead status display, without the # prefix. |
| `hidden` | boolean | No | Whether or not the lead status is hidden. Defaults to false. |
| `sortPosition` | integer | No | Sort position for ordering lead statuses. Defaults to 100. |
| `transitionToId` | string | No | A ULID entity identifier for the lead status to transition to after a specified interval. |
| `externalMappings` | array | No | List of external system mappings for this lead status. |
| `transitionInterval` | integer | No | The interval duration before transitioning to another status. |
| `transitionIntervalUnit` | string ("day" | "week" | "month" | "year") | No | Unit for transition interval. |
| `transitionClosedReasonId` | string | No | A ULID entity identifier for the closed reason when transitioning. |
| `afterFormSentTransitionToId` | string | No | A ULID entity identifier for the lead status to transition to after a form is sent. |
| `afterEmailSentTransitionToId` | string | No | A ULID entity identifier for the lead status to transition to after an email is sent. |
| `afterQuoteSentTransitionToId` | string | No | A ULID entity identifier for the lead status to transition to after a quote is sent. |
| `afterDocumentSentTransitionToId` | string | No | A ULID entity identifier for the lead status to transition to after a document is sent. |
| `afterEventScheduledTransitionToId` | string | No | A ULID entity identifier for the lead status to transition to after an event is scheduled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Note

**Slug:** `TAVE_CREATE_RESOURCE_NOTE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Date of the note in YYYY-MM-DD format (in studio timezone) |
| `jobId` | string | No | ULID identifier of the job to attach the note to |
| `hidden` | boolean | No | Whether the note is hidden from view |
| `authorId` | string | No | ULID identifier of the author of the note |
| `contactId` | string | No | ULID identifier of the contact to attach the note to |
| `contentHtml` | string | Yes | HTML content of the note. This is the main body of the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Payment

**Slug:** `TAVE_CREATE_RESOURCE_PAYMENT`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product

**Slug:** `TAVE_CREATE_RESOURCE_PRODUCT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sku` | string | No | Stock Keeping Unit (SKU) for the product. |
| `name` | string | Yes | The name of the product. |
| `price` | integer | Yes | Positive numeric representing the product price in the studio's currency. |
| `hidden` | boolean | No | Whether or not the product is hidden. |
| `taxable` | boolean | No | Whether the product is taxable. |
| `expenses` | array | No | Array of product expenses. |
| `vendorId` | string | No | A ULID entity identifier for the vendor. Can be null. |
| `deliverable` | boolean | No | Whether the product is deliverable. |
| `manualEntry` | boolean | No | Whether the product allows manual entry. |
| `expenseDueFrom` | string ("JobDate" | "Booking" | "Never") | No | When the expense is due from. |
| `descriptionHtml` | string | No | HTML description of the product. |
| `expenseDuePeriod` | number | No | Number of periods until expense is due (max 5 digits). |
| `expenseCategoryId` | string | No | A ULID entity identifier for the expense category. Can be null. |
| `expenseDuePeriodType` | string ("Days" | "Weeks" | "Months") | No | Period type for expense due date calculation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product Type

**Slug:** `TAVE_CREATE_RESOURCE_PRODUCT_TYPE`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Profit Center

**Slug:** `TAVE_CREATE_RESOURCE_PROFIT_CENTER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the profit center. Must be between 1 and 24 characters. |
| `hidden` | boolean | No | Whether or not the profit center is hidden. Defaults to false. |
| `externalMappings` | array | No | List of external system mappings for this profit center. These objects cannot be updated currently. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create RestHook Subscription

**Slug:** `TAVE_CREATE_RESOURCE_REST_HOOK`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Webhook callback URL that will receive POST requests when the event occurs |
| `event` | string ("contact.created" | "job.created" | "order.booked" | "payment.created") | Yes | Type of event that will trigger this webhook (contact.created, job.created, order.booked, or payment.created) |
| `limitTo` | object | No | Optional filters to limit which events trigger the webhook. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tax Rate

**Slug:** `TAVE_CREATE_RESOURCE_TAX_RATE`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create User

**Slug:** `TAVE_CREATE_USER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hidden` | boolean | No | Whether the user is hidden from certain views. |
| `isAdmin` | boolean | No | Whether the user has admin privileges. Defaults to false. |
| `username` | string | Yes | Email address to be used as the username. Must be between 5 and 64 characters and follow email format. |
| `contactId` | string | Yes | ULID identifier of the contact to associate with this user. The contact must exist in the address book. |
| `hasBetaAccess` | boolean | No | Whether the user has beta feature access. Defaults to false. |
| `isBillingContact` | boolean | No | Whether the user is a billing contact. Defaults to false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Address Book Entry

**Slug:** `TAVE_DELETE_ADDRESS_BOOK_ENTRY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the address book entry to delete. Permanently removes the entry from the address book. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Brand

**Slug:** `TAVE_DELETE_BRAND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the brand to delete. This is the unique identifier that was returned when the brand was created or listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Custom Field

**Slug:** `TAVE_DELETE_CUSTOM_FIELD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the custom field to delete. Example: 01khbe6hhn2j76hrffy0mxmq6h |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Event Type

**Slug:** `TAVE_DELETE_EVENT_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the event type to delete. Example: '01h35ccwymj5ctckp8px1azhg6'. This action permanently removes the event type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Gallery

**Slug:** `TAVE_DELETE_GALLERY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the gallery to delete. WARNING: This permanently deletes the gallery. This action cannot be undone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Discount

**Slug:** `TAVE_DELETE_RESOURCE_DISCOUNT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the discount to delete. This is the unique identifier that was returned when the discount was created or listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Discount Type

**Slug:** `TAVE_DELETE_RESOURCE_DISCOUNT_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the discount type to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Event

**Slug:** `TAVE_DELETE_RESOURCE_EVENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the event to delete. This action permanently removes the event from the system. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Job

**Slug:** `TAVE_DELETE_RESOURCE_JOB`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the job to delete. Example: '01khbe89198bmv8z0615c2rzv2'. This action permanently removes the job from the system. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Job Closed Reason

**Slug:** `TAVE_DELETE_RESOURCE_JOB_CLOSED_REASON`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the job closed reason to delete. Example: '01khbe88gp5yycxgndb848nej0'. This action permanently removes the job closed reason. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Job Contact

**Slug:** `TAVE_DELETE_RESOURCE_JOB_CONTACT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the job contact to delete. This is the unique identifier that was returned when the job contact was created or listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Job Role

**Slug:** `TAVE_DELETE_RESOURCE_JOB_ROLE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the job role to delete. Example: '01khbe9106mwgkwvknfme3mgjw'. This action permanently removes the job role from the system. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Job Type

**Slug:** `TAVE_DELETE_RESOURCE_JOB_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the job type to delete. This is the unique identifier that was returned when the job type was created or listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Lead Source

**Slug:** `TAVE_DELETE_RESOURCE_LEAD_SOURCE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the lead source to delete. This action permanently removes the lead source from the system. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Lead Status

**Slug:** `TAVE_DELETE_RESOURCE_LEAD_STATUS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the lead status to delete. This action permanently removes the lead status from the system. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Note

**Slug:** `TAVE_DELETE_RESOURCE_NOTE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the note to delete. This action performs a soft delete by setting the 'hidden' field to true rather than permanently removing the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Payment

**Slug:** `TAVE_DELETE_RESOURCE_PAYMENTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the payment to delete. This is the unique identifier that was returned when the payment was created or listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Product

**Slug:** `TAVE_DELETE_RESOURCE_PRODUCT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the product to delete. This is the unique identifier that was returned when the product was created or listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Product Type

**Slug:** `TAVE_DELETE_RESOURCE_PRODUCT_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the product type to delete. This is the unique identifier that was returned when the product type was created or listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Profit Center

**Slug:** `TAVE_DELETE_RESOURCE_PROFIT_CENTER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the profit center to delete. This is the unique identifier that was returned when the profit center was created or listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete RestHook

**Slug:** `TAVE_DELETE_RESOURCE_REST_HOOK`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the RestHook to delete. This is the unique identifier that was returned when the RestHook was created or listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tax Group

**Slug:** `TAVE_DELETE_RESOURCE_TAX_GROUP`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the tax group to delete. This is the unique identifier that was returned when the tax group was created or listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tax Rate

**Slug:** `TAVE_DELETE_RESOURCE_TAX_RATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the tax rate to delete. This is the unique identifier that was returned when the tax rate was created or listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User

**Slug:** `TAVE_DELETE_RESOURCE_USER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the user to delete. This is the unique identifier for the user resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Brand

**Slug:** `TAVE_GET_BRAND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the brand to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Event

**Slug:** `TAVE_GET_EVENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID to perform an action on. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Event Type

**Slug:** `TAVE_GET_EVENT_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the event type to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Gallery

**Slug:** `TAVE_GET_GALLERY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID to perform an action on. The unique identifier of the gallery to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Address Book Entity

**Slug:** `TAVE_GET_RESOURCE_ADDRESS_BOOK`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID to perform an action on. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Address Book Address

**Slug:** `TAVE_GET_RESOURCE_ADDRESS_BOOK_CA`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID to perform an action on. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Field

**Slug:** `TAVE_GET_RESOURCE_CUSTOM_FIELD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the custom field to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Discount

**Slug:** `TAVE_GET_RESOURCE_DISCOUNT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the discount to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Discount Type

**Slug:** `TAVE_GET_RESOURCE_DISCOUNT_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID to perform an action on. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job

**Slug:** `TAVE_GET_RESOURCE_JOB`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the job to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Closed Reason

**Slug:** `TAVE_GET_RESOURCE_JOB_CLOSED_REASON`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the job closed reason to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Contact

**Slug:** `TAVE_GET_RESOURCE_JOB_CONTACT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the job contact to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Role

**Slug:** `TAVE_GET_RESOURCE_JOB_ROLE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the job role to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Type

**Slug:** `TAVE_GET_RESOURCE_JOB_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the job type to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Worksheet

**Slug:** `TAVE_GET_RESOURCE_JOB_WORKSHEET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jobId` | string | Yes | ULID identifier of the job to retrieve the worksheet for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Lead Source

**Slug:** `TAVE_GET_RESOURCE_LEAD_SOURCE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the lead source to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Lead Status

**Slug:** `TAVE_GET_RESOURCE_LEAD_STATUS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the lead status to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get My Studio

**Slug:** `TAVE_GET_RESOURCE_MY_STUDIO`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Note

**Slug:** `TAVE_GET_RESOURCE_NOTE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the note to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order

**Slug:** `TAVE_GET_RESOURCE_ORDER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the order to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Payment

**Slug:** `TAVE_GET_RESOURCE_PAYMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the payment to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Payment Method

**Slug:** `TAVE_GET_RESOURCE_PAYMENT_METHOD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the payment method to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product

**Slug:** `TAVE_GET_RESOURCE_PRODUCT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the product to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product Type

**Slug:** `TAVE_GET_RESOURCE_PRODUCT_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the product type to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Profit Center

**Slug:** `TAVE_GET_RESOURCE_PROFIT_CENTER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the profit center to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tax Rate

**Slug:** `TAVE_GET_RESOURCE_TAX_RATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the tax rate to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Timezone

**Slug:** `TAVE_GET_RESOURCE_TIMEZONE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the timezone to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User by ID

**Slug:** `TAVE_GET_RESOURCE_USER`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID to perform an action on. A lowercase ULID entity identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Address Book Contacts

**Slug:** `TAVE_LIST_ADDRESS_BOOK`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `email` | string | No | Filter contacts by email. When specified, results are ranked by match quality. |
| `sortBy` | string | No | Sort items in the collection by the given property (e.g., id, name, email, modified, created). |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include contacts that have been hidden. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Brands

**Slug:** `TAVE_LIST_BRANDS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include objects that have been hidden |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Discount Types

**Slug:** `TAVE_LIST_DISCOUNT_TYPES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sortBy` | string | No | Sort items in the collection by the given property. Default is 'id'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Studio Events

**Slug:** `TAVE_LIST_EVENTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `jobId` | string | No | Include objects attached to a job |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include objects that have been hidden |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Event Types

**Slug:** `TAVE_LIST_EVENT_TYPES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include objects that have been hidden |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Files

**Slug:** `TAVE_LIST_FILES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `jobId` | string | No | Include objects attached to a job. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `contactId` | string | No | A ULID entity identifier for filtering files by contact. |
| `includeHidden` | boolean | No | Include objects that have been hidden. |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Custom Fields

**Slug:** `TAVE_LIST_RESOURCE_CUSTOM_FIELD`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Discount

**Slug:** `TAVE_LIST_RESOURCE_DISCOUNT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sortBy` | string | No | Sort items in the collection by the given property. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Galleries

**Slug:** `TAVE_LIST_RESOURCE_GALLERY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include objects that have been hidden |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Job

**Slug:** `TAVE_LIST_RESOURCE_JOB`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeClosed` | boolean | No | Include jobs that have been closed |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Job Closed Reasons

**Slug:** `TAVE_LIST_RESOURCE_JOB_CLOSED_REASON`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include objects that have been hidden |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Job Contact

**Slug:** `TAVE_LIST_RESOURCE_JOB_CONTACT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `jobId` | string | No | Include objects attached to a job |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `contactId` | string | No | A ULID entity identifier that is nullable. |
| `includeHidden` | boolean | No | Include objects that have been hidden |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Job Orders

**Slug:** `TAVE_LIST_RESOURCE_JOB_ORDERS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jobId` | string | Yes | A lowercase ULID entity identifier for the job |
| `sortBy` | string | No | Sort items in the collection by the given property. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Job Payments

**Slug:** `TAVE_LIST_RESOURCE_JOB_PAYMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the job to get payments for. |
| `sortBy` | string | No | Sort items in the collection by the given property. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Job Roles

**Slug:** `TAVE_LIST_RESOURCE_JOB_ROLE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include objects that have been hidden |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Job Type

**Slug:** `TAVE_LIST_RESOURCE_JOB_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include objects that have been hidden |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Lead Source

**Slug:** `TAVE_LIST_RESOURCE_LEAD_SOURCE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include objects that have been hidden |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Lead Status

**Slug:** `TAVE_LIST_RESOURCE_LEAD_STATUS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include objects that have been hidden |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Note

**Slug:** `TAVE_LIST_RESOURCE_NOTE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `jobId` | string | No | Include objects attached to a job |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include objects that have been hidden |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Order

**Slug:** `TAVE_LIST_RESOURCE_ORDER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Payment

**Slug:** `TAVE_LIST_RESOURCE_PAYMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Payment Method

**Slug:** `TAVE_LIST_RESOURCE_PAYMENT_METHOD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sortBy` | string | No | Sort items in the collection by the given property. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Product

**Slug:** `TAVE_LIST_RESOURCE_PRODUCT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sortBy` | string | No | Sort items in the collection by the given property. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Types

**Slug:** `TAVE_LIST_RESOURCE_PRODUCT_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sortBy` | string | No | Sort items in the collection by the given property. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Profit Center

**Slug:** `TAVE_LIST_RESOURCE_PROFIT_CENTER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include objects that have been hidden |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List REST Hooks

**Slug:** `TAVE_LIST_RESOURCE_REST_HOOK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include objects that have been hidden |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Tax Groups

**Slug:** `TAVE_LIST_RESOURCE_TAX_GROUPS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sortBy` | string | No | Sort items in the collection by the given property. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Tax Rates

**Slug:** `TAVE_LIST_RESOURCE_TAX_RATES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sortBy` | string | No | Sort items in the collection by the given property. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource Timezone

**Slug:** `TAVE_LIST_RESOURCE_TIMEZONE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `search` | string | No | Search Timezone by name, code, country, etc. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resource User

**Slug:** `TAVE_LIST_RESOURCE_USER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. |
| `sortBy` | string | No | Sort items in the collection by the given property. |
| `pageSize` | integer | No | Number of results per page to return in the collection. |
| `includeHidden` | boolean | No | Include objects that have been hidden |
| `externalMappingId` | string | No | Filter objects by an external id for this provider. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Address Book Entry

**Slug:** `TAVE_UPDATE_ADDRESS_BOOK`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID of the address book entry to update |
| `fax` | object | No | Phone number object |
| `url` | string | No | Website URL |
| `kind` | string ("person" | "company" | "location") | Yes | Type of address book entry: person, company, or location |
| `email` | string | No | Primary email address |
| `gender` | string | No | Gender |
| `hidden` | boolean | No | Whether the entry is hidden from default views |
| `pinned` | boolean | No | Whether the entry is pinned for quick access |
| `address` | string | No | Physical address |
| `brandId` | string | No | Associated brand ID |
| `jobTitle` | string | No | Job title |
| `lastName` | string | No | Last name (typically used for person kind) |
| `birthdate` | string | No | Birth date |
| `cellPhone` | object | No | Phone number object |
| `firstName` | string | No | First name (typically used for person kind) |
| `homePhone` | object | No | Phone number object |
| `workPhone` | object | No | Phone number object |
| `maidenName` | string | No | Maiden name |
| `salutation` | string | No | Salutation or title |
| `anniversary` | string | No | Anniversary date |
| `companyName` | string | No | Company name (typically used for company kind) |
| `privacyOptIn` | boolean | No | Privacy opt-in status for communications |
| `mailingAddress` | string | No | Mailing address if different from physical address |
| `previousClient` | boolean | No | Whether this contact is a previous client |
| `secondaryEmail` | string | No | Secondary email address |
| `twitterUsername` | string | No | Twitter username |
| `facebookUsername` | string | No | Facebook username |
| `requireStrictPrivacy` | boolean | No | Whether strict privacy requirements apply to this contact |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Brand

**Slug:** `TAVE_UPDATE_BRAND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the brand to update |
| `bcc` | string | No | BCC email address for brand communications |
| `name` | string | No | The brand's name (4-128 characters) |
| `alias` | string | No | Brand alias (4-32 characters) |
| `theme` | object | No | Theme configuration for the brand. |
| `hidden` | boolean | No | Whether the brand is hidden |
| `phone1` | object | No | Phone number configuration for the brand. |
| `phone2` | object | No | Phone number configuration for the brand. |
| `phone3` | object | No | Phone number configuration for the brand. |
| `replyTo` | string | No | Reply-to email address for brand communications |
| `forwardTo` | string | No | Forward-to email address for brand communications |
| `shortName` | string | No | Shorter name for the brand to be used in constrained UI places (4-128 characters) |
| `locationId` | string | No | ULID of the associated location |
| `officeHours` | string | No | Office hours for the brand |
| `customDomain` | string | No | Custom domain for the brand |
| `externalMappings` | array | No | External system mappings for the brand |
| `enableProfileEdit` | boolean | No | Whether to enable profile editing |
| `googleAnalyticsId` | string | No | Google Analytics tracking ID (format: UA-XXXXXX-X, YT-XXXXXX-X, or MO-XXXXXX-X) |
| `rootContactFormId` | string | No | ULID of the root contact form |
| `customDomainStatus` | string ("active" | "pending" | "dns-failed" | "ssl-failed") | No | Status of the custom domain configuration. |
| `clientAccessVersion` | integer | No | Client access version (1-10) |
| `showHistoryInPortal` | boolean | No | Whether to show history in the client portal |
| `breakoutPackagePricing` | boolean | No | Whether to break out package pricing |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Event Type

**Slug:** `TAVE_UPDATE_EVENT_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the event type to update |
| `kind` | string ("call" | "meeting" | "other" | "session") | No | Event type kind options. |
| `name` | string | Yes | Name of the event type (1-24 characters) |
| `color` | string | No | Hex color code for the event type (6 characters, lowercase hex) |
| `hidden` | boolean | No | Whether the event type is hidden from view |
| `tokenPrefix` | string | Yes | 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 |
| `sortPosition` | integer | No | Sort position for ordering event types (0-65535) |
| `defaultDuration` | integer | No | Default duration for events of this type in minutes (5-86400) |
| `defaultAttendees` | array | No | List of default attendee token prefixes (lowercase alphanumeric and underscores, 1-32 chars each) |
| `externalMappings` | array | No | External system mappings for this event type |
| `defaultLocationId` | string | No | ULID of the default location for this event type |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Custom Field

**Slug:** `TAVE_UPDATE_RESOURCE_CUSTOM_FIELD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the custom field to update |
| `kind` | string ("TextField" | "TextBox" | "DropDown" | "Number" | "Decimal" | "Money" | "Date" | "Time" | "Checkbox") | No | Enum for the kind of custom field. |
| `name` | string | No | Name of the custom field (max 255 characters) |
| `token` | string | No | Token identifier for the custom field (max 128 characters) |
| `hidden` | boolean | No | Whether the custom field is hidden |
| `choices` | array | No | List of choices for DropDown kind custom fields |
| `can_apply_to` | string ("Job" | "Contact") | No | Enum for the type of resource the custom field can apply to. |
| `client_label` | string | No | Label displayed to clients (max 255 characters) |
| `client_access` | string ("None" | "Visible" | "Editable") | No | Enum for the client access level of the custom field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Event

**Slug:** `TAVE_UPDATE_RESOURCE_EVENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the event to update |
| `name` | string | No | Name of the event |
| `jobId` | string | No | ULID identifier of the associated job |
| `allDay` | boolean | No | Whether the event is all-day |
| `hidden` | boolean | No | Whether the event is hidden from view |
| `typeId` | string | No | ULID identifier of the event type |
| `channel` | string ("InPerson" | "Phone" | "Virtual") | No | Event channel type. |
| `endDate` | string | No | End date in YYYY-MM-DD format |
| `endTime` | string | No | End time in 24-hour format (HH:MM:SS) |
| `location` | object | No | Event location details. |
| `confirmed` | boolean | No | Whether the event is confirmed |
| `galleryId` | string | No | ULID identifier of the associated gallery |
| `startDate` | string | No | Start date in YYYY-MM-DD format |
| `startTime` | string | No | Start time in 24-hour format (HH:MM:SS) |
| `timezoneId` | string | No | ULID identifier of the timezone |
| `virtualUrl` | string | No | URL for virtual events |
| `phoneNumber` | object | No | Phone number representation. |
| `timezoneName` | string | No | Timezone name (ignored if timezoneId is provided) |
| `descriptionHtml` | string | No | HTML description of the event |
| `externalMappings` | array | No | External system mappings |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Gallery

**Slug:** `TAVE_UPDATE_RESOURCE_GALLERY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the gallery to update. |
| `name` | string | Yes | The name of this gallery. Required for PUT updates. |
| `slug` | string | No | The URL path slug for this gallery. Must contain only letters, numbers, dashes, and underscores. Will be converted to lowercase. |
| `jobId` | string | No | A ULID entity identifier for the job this gallery is associated with. |
| `hidden` | boolean | No | Whether this gallery is hidden. |
| `public` | boolean | No | Whether this gallery is publicly accessible. |
| `status` | string ("pre-release" | "active" | "inactive" | "archived") | No | Status of a gallery. |
| `eventId` | string | No | A ULID entity identifier for the event this gallery is associated with. |
| `adminUrl` | string | Yes | 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. |
| `category` | string | No | The category of this gallery. Galleries may be grouped by this category text in future client portal designs. |
| `headline` | string | No | The headline of this gallery. Prioritized over name when displayed to the user. |
| `password` | string | No | A reusable plain-text passcode for unlocking the gallery. This pass code may be given to invited users. |
| `remoteId` | string | Yes | The remote ID of this gallery. This value must be unique for the studio. Required for PUT updates. |
| `clientUrl` | string | Yes | The URL of this gallery. Will be used for links in emails and the client portal. Required for PUT updates. |
| `eventDate` | string | No | The date of the event this gallery is for in YYYY-MM-DD format. Useful in automations or email tokens. |
| `coverPhoto` | object | No | Cover photo details for a gallery. |
| `releaseDate` | string | No | The date this gallery will be released to the public in YYYY-MM-DD format. Useful in automations or email tokens. |
| `orderDueDate` | string | No | The date that orders for this gallery are due by in YYYY-MM-DD format. Useful in automations or email tokens. |
| `remoteCreated` | string | Yes | The creation date and time of this gallery in UTC (ISO 8601 format). Required for PUT updates. |
| `expirationDate` | string | No | The date this gallery will expire and no longer be accessible in YYYY-MM-DD format. Useful in automations or email tokens. |
| `externalMappings` | array | No | External mappings to relate this gallery to entities in external systems. |
| `requiresPassword` | boolean | No | Whether this gallery requires a password for access. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Job

**Slug:** `TAVE_UPDATE_RESOURCE_JOB`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the job to update |
| `name` | string | No | Name of the job that will override the auto-generated title |
| `stage` | string ("lead" | "booked" | "fulfillment" | "completed") | No | Stage of the job in the workflow. |
| `closed` | boolean | No | Whether the lead or job is closed |
| `pinned` | boolean | No | Whether the job is favorited/pinned |
| `sample` | boolean | No | Whether the lead or job is a sample job |
| `brandId` | string | No | ULID identifier of the brand |
| `webLead` | boolean | No | Whether the lead or job came from a contact form |
| `eventDate` | string | No | Event date in YYYY-MM-DD format (in studio timezone) |
| `jobTypeId` | string | No | ULID identifier of the job type |
| `leadNotes` | string | No | Notes about the lead |
| `closedDate` | string | No | Date when the job was closed in YYYY-MM-DD format (in studio timezone) |
| `guestCount` | integer | No | Number of guests for the event |
| `leadRating` | integer | No | Rating for the lead (1-5) |
| `workflowId` | string | No | ULID identifier of the workflow |
| `bookingDate` | string | No | Booking date in YYYY-MM-DD format (in studio timezone) |
| `inquiryDate` | string | No | Inquiry date in YYYY-MM-DD format (in studio timezone) |
| `customFields` | array | No | List of custom field values for the job |
| `customNumber` | string | No | Custom job number or identifier |
| `leadSourceId` | string | No | ULID identifier of the lead source |
| `leadStatusId` | string | No | ULID identifier of the lead status |
| `completedDate` | string | No | Completion date in YYYY-MM-DD format (in studio timezone) |
| `contactFormId` | string | No | ULID identifier of the contact form |
| `leadMaxBudget` | integer | No | Maximum budget for the lead in the studio's currency |
| `closedReasonId` | string | No | ULID identifier of the closed reason |
| `leadConfidence` | string ("low" | "medium" | "high") | No | Confidence level for a lead. |
| `fulfillmentDate` | string | No | Fulfillment date in YYYY-MM-DD format (in studio timezone) |
| `externalMappings` | array | No | List of external system mappings |
| `leadDecisionExpectedByDate` | string | No | Expected decision date for the lead in YYYY-MM-DD format (in studio timezone) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Job Closed Reason

**Slug:** `TAVE_UPDATE_RESOURCE_JOB_CLOSED_REASON`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the job closed reason to update |
| `name` | string | Yes | Name of the job closed reason (1-32 characters) |
| `hidden` | boolean | No | Whether the job closed reason is hidden from view |
| `description` | string | No | Optional description of the job closed reason (max 64 characters) |
| `externalMappings` | array | No | External system mappings for this job closed reason |
| `includedInReporting` | boolean | No | Whether this reason should be included in reporting |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Job Contact

**Slug:** `TAVE_UPDATE_RESOURCE_JOB_CONTACT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the job contact to update |
| `jobId` | string | Yes | ULID identifier of the job |
| `client` | boolean | No | Whether this contact is the primary client for the job |
| `hidden` | boolean | No | Whether the job contact is hidden from view |
| `jobRoles` | array | No | List of job role ULID identifiers associated with this contact |
| `contactId` | string | Yes | ULID identifier of the contact |
| `roleKinds` | array | No | List of role kinds for this job contact (client, customer, team, subject, vendor) |
| `externalMappings` | array | No | External system mappings for this job contact |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Job Role

**Slug:** `TAVE_UPDATE_RESOURCE_JOB_ROLE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the job role to update |
| `kind` | string ("customer" | "subject" | "team" | "vendor") | No | Type/kind of the job role |
| `name` | string | Yes | Name of the job role (1-24 characters) |
| `hidden` | boolean | No | Whether the job role is hidden from view |
| `tokenPrefix` | string | Yes | 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 |
| `sortPosition` | integer | No | Sort position for ordering job roles (0-65535) |
| `externalMappings` | array | No | External system mappings for this job role |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Job Type

**Slug:** `TAVE_UPDATE_RESOURCE_JOB_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the job type to update |
| `name` | string | Yes | The name of this job type |
| `hidden` | boolean | No | Whether or not the job type is hidden |
| `workflowId` | string | No | ULID identifier of the workflow for this job type |
| `sortPosition` | integer | No | Sort position for ordering job types (0-65535) |
| `defaultEvents` | array | No | List of default event types to associate with this job type |
| `profitCenterId` | string | No | ULID identifier of the profit center for this job type |
| `defaultContacts` | array | No | List of default job roles to associate with this job type |
| `externalMappings` | array | No | List of external system mappings for this job type |
| `initialLeadStatusId` | string | No | ULID identifier of the initial lead status for this job type |
| `primarySessionRequired` | boolean | No | Whether a primary session is required for jobs of this type |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Lead Source

**Slug:** `TAVE_UPDATE_RESOURCE_LEAD_SOURCE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the lead source to update |
| `name` | string | Yes | The name of the lead source. Must be between 3 and 128 characters. This field is required for updates. |
| `hidden` | boolean | No | Whether or not the lead source is hidden. |
| `parentId` | string | No | A ULID entity identifier for the parent lead source, if this is a nested/child lead source. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Lead Status

**Slug:** `TAVE_UPDATE_RESOURCE_LEAD_STATUS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the lead status to update |
| `kind` | string ("general" | "new" | "stale") | No | Enum for lead status kind values. |
| `name` | string | No | The name of the lead status. Must be between 1 and 64 characters. |
| `color` | string | No | Hex color code for the lead status (6 characters, lowercase hex). Example: '278639' for green. |
| `hidden` | boolean | No | Whether or not the lead status is hidden. |
| `sortPosition` | integer | No | Sort position for ordering lead statuses. Must be between 0 and 65535. |
| `transitionToId` | string | No | ULID of the lead status to transition to automatically based on time interval. |
| `externalMappings` | array | No | List of external system mappings for this lead status. |
| `transitionInterval` | integer | No | Time interval for automatic transition. Must be between 0 and 99999999999. |
| `transitionIntervalUnit` | string ("day" | "week" | "month" | "year") | No | Enum for transition interval unit values. |
| `transitionClosedReasonId` | string | No | ULID of the closed reason to use when transitioning to a closed status. |
| `afterFormSentTransitionToId` | string | No | ULID of the lead status to transition to after a form is sent. |
| `afterEmailSentTransitionToId` | string | No | ULID of the lead status to transition to after an email is sent. |
| `afterQuoteSentTransitionToId` | string | No | ULID of the lead status to transition to after a quote is sent. |
| `afterDocumentSentTransitionToId` | string | No | ULID of the lead status to transition to after a document is sent. |
| `afterEventScheduledTransitionToId` | string | No | ULID of the lead status to transition to after an event is scheduled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Note

**Slug:** `TAVE_UPDATE_RESOURCE_NOTE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the note to update |
| `date` | string | No | Date string in YYYY-MM-DD format in the timezone of the event or studio. |
| `jobId` | string | No | ULID identifier of the job associated with the note. |
| `hidden` | boolean | No | Whether or not the note is hidden. |
| `authorId` | string | No | ULID identifier of the author of the note. |
| `contactId` | string | No | ULID identifier of the contact associated with the note. |
| `contentHtml` | string | Yes | HTML content of the note. This is a required field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Order

**Slug:** `TAVE_UPDATE_RESOURCE_ORDER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the order to update |
| `name` | string | No | Custom name for the order |
| `title` | string | No | Name or auto-generated title of the order |
| `hidden` | boolean | No | Whether the order is hidden |
| `status` | string ("draft" | "open" | "paid-in-full" | "completed" | "voided") | No | Status of the order. |
| `dueDate` | string | No | Due date for the order in YYYY-MM-DD format |
| `bookedOn` | string | No | Date when the order was booked in YYYY-MM-DD format |
| `lineItems` | array | No | List of line items for the order |
| `taxGroupId` | string | No | ULID identifier of the tax group for calculating taxes |
| `recipientId` | string | No | ULID identifier of the recipient from the address book |
| `customNumber` | string | No | Custom order number or identifier (max 16 characters) |
| `referenceCode` | string | No | Reference code for the order (max 11 characters) |
| `paymentTermsId` | string | No | ULID identifier of the payment terms |
| `preTaxDiscount` | object | No | Discount applied to an order. |
| `bookedFromQuote` | boolean | No | Whether the order was booked from a quote |
| `afterTaxDiscount` | object | No | Discount applied to an order. |
| `taxIsCompounding` | boolean | No | Whether taxes are compounded (tax the tax) |
| `bookedElectronically` | boolean | No | Whether the order was booked electronically |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Profit Center

**Slug:** `TAVE_UPDATE_RESOURCE_PROFIT_CENTER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the profit center to update |
| `name` | string | No | The name of the profit center. Must be between 1 and 24 characters. |
| `hidden` | boolean | No | Whether or not the profit center is hidden. |
| `externalMappings` | array | No | List of external system mappings for this profit center. These objects cannot be updated currently. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tax Group

**Slug:** `TAVE_UPDATE_RESOURCE_TAX_GROUP`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the tax group to update |
| `name` | string | No | Name of the tax group (max 64 characters) |
| `hidden` | boolean | No | Whether the tax group is hidden |
| `default` | boolean | No | Whether this is the default tax group |
| `taxRates` | array | No | List of tax rates associated with this tax group (max 3 items) |
| `compounding` | boolean | No | Whether the tax group uses compounding (taxes applied sequentially) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tax Rate

**Slug:** `TAVE_UPDATE_RESOURCE_TAX_RATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the tax rate to update |
| `name` | string | No | Name of the tax rate (max 32 characters) |
| `rate` | number | No | The floating point number representing the tax rate percentage. Has 4 points of decimal precision. |
| `hidden` | boolean | No | Whether the tax rate is hidden from view |
| `inclusive` | boolean | No | Whether the tax is inclusive (included in the price) or exclusive (added to the price) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User

**Slug:** `TAVE_UPDATE_RESOURCE_USER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ULID identifier of the user to update |
| `hidden` | boolean | No | Whether or not the user is hidden. |
| `isAdmin` | boolean | No | Whether or not the user is an admin. |
| `username` | string | No | Email address used as username. Must be between 5 and 64 characters. |
| `contactId` | string | No | A lowercase ULID entity identifier for the contact associated with this user. |
| `hasBetaAccess` | boolean | No | Whether or not the user has beta access. |
| `isBillingContact` | boolean | No | Whether or not the user is a billing contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Studio Readonly Mode

**Slug:** `TAVE_UPDATE_STUDIO_READONLY_MODE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | Yes | Whether to enable or disable readonly mode for the studio. When enabled, the studio will be in readonly mode. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
