Skip to main content
Jobber logo
  • Category: crm
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 36
  • Triggers: 0
  • Slug: JOBBER
  • Version: 20261101_00

Tools

Slug: JOBBER_CREATE_CLIENTCreate an individual or company client in Jobber with optional primary email and phone contact details. Provide at least one of first_name, last_name, or company_name. Jobber provides no client deletion path, so this leaves a persistent record.

Input Parameters

string
Primary email address to add to the client.
string
Primary phone number to add to the client.
string ("MR" | "MS" | "MRS" | "MISS" | "DR")
Optional title for an individual client.
string
Client’s last name.
string
Client’s first name.
boolean
Whether this client represents a company.
string ("MAIN" | "WORK" | "MOBILE" | "HOME" | "FAX" | "OTHER")
Label for phone, used only when phone is provided.
string
Company name for a business client.
boolean
Whether the client receives appointment reminders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_CREATE_CUSTOM_FIELD_CONFIGURATIONCreate one Jobber TEXT, LINK, AREA, TRUE_FALSE, NUMERIC, or DROPDOWN custom-field definition through a fixed type-specific mutation. WARNING: this persistent administrative write requires Jobber Connect+ (Connect or higher) and the Custom Field Configurations write permission. Creation is persistent, and Jobber provides apps no supported cleanup or deletion path for a custom field they configure.

Input Parameters

string
required
Non-empty name for the custom field.
string
Required non-empty unit for AREA and NUMERIC fields.
boolean
Controls whether Jobber users can edit field values: true prevents editing; false allows editing.
string ("ALL_PROPERTIES" | "ALL_CLIENTS" | "ALL_QUOTES" | "ALL_JOBS" | "ALL_INVOICES" | "ALL_PRODUCTS_AND_SERVICES" | "TEAM")
required
Jobber object category to which this custom field will apply.
string ("TEXT" | "LINK" | "AREA" | "TRUE_FALSE" | "NUMERIC" | "DROPDOWN")
required
Value type of the custom field; selects one fixed Jobber create mutation.
string
Optional URL paired with a LINK default_text. Invalid for other types.
string
Optional TEXT default, or required non-empty LINK text when a LINK default is supplied. Invalid for other field types.
boolean
Whether values transfer to linked work objects in Jobber workflows.
number
Optional non-negative AREA default width.
number
Optional non-negative AREA default length.
number
Optional NUMERIC default. Zero and negative values are preserved.
boolean
Required TRUE_FALSE default. Both true and false are valid.
array
Required when field_type is DROPDOWN; provide one to 100 unique non-empty options.
string
Optional DROPDOWN default; it must exactly match one dropdown option.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_CREATE_JOBCreate a basic one-off Jobber job for an existing property with an explicit invoicing strategy. Jobber provides no job deletion path, so this leaves a persistent record.

Input Parameters

string
Human-readable job title.
string
ISO 8601 date when the job timeframe starts.
string
required
Opaque Jobber property EncodedId that owns the job.
string
Instructions for the job team.
string ("DAYS" | "WEEKS" | "MONTHS" | "YEARS")
Unit for duration_value.
integer
Length of the job timeframe; requires duration_unit.
string ("FIXED_PRICE" | "VISIT_BASED")
required
How charges are calculated for the job.
string
Opaque Jobber user EncodedId for the salesperson.
string ("ON_COMPLETION" | "PERIODIC" | "PER_VISIT" | "NEVER")
required
When invoices should be created for the job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_CREATE_NOTECreate a note on exactly one Jobber client, job, quote, invoice, or request. The resource type selects a fixed provider mutation, and unsupported cross-resource link options are rejected. Created notes persist, and this toolkit has no general delete-note action across all five resource types. Attachments are not supported.

Input Parameters

boolean
Whether the note should be pinned.
string
required
Non-empty note message.
string
required
Opaque Jobber EncodedId of the client, job, quote, invoice, or request.
For CLIENT, QUOTE, or REQUEST notes, whether to link related jobs.
string ("CLIENT" | "JOB" | "QUOTE" | "INVOICE" | "REQUEST")
required
Type of Jobber resource that will own the note.
For CLIENT or REQUEST notes, whether to link related quotes.
For CLIENT, JOB, QUOTE, or REQUEST notes, whether to link related invoices.
For CLIENT notes, whether to link related requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_CREATE_QUOTECreate a persistent draft quote for an existing Jobber client and property with one or more explicit line items. Setting a line item’s save_to_products_and_services flag to true also creates a persistent copy in Jobber’s products and services catalog. Jobber exposes no quote deletion root, so this action leaves a persistent business record.

Input Parameters

string
Customer-facing quote title.
object
Optional deposit object with required non-negative rate and type; type must be Percent for a percentage or Unit for a fixed amount.
string
Customer-facing message included with the quote.
object
Optional discount object with required non-negative rate and type; type must be Percent for a percentage or Unit for a fixed amount.
string
required
Opaque Jobber EncodedId of the client receiving the quote.
array
required
One to 100 objects, each with required non-empty name and optional description, category (PRODUCT, SERVICE, or LABOUR), taxable, save_to_products_and_services (defaults to false), non-negative unit_price, non-negative quantity, and product_or_service_id. Setting save_to_products_and_services to true creates a persistent copy of that line item in Jobber’s products and services catalog.
string
Opaque Jobber EncodedId of the request associated with the quote.
string
required
Opaque Jobber EncodedId of the property covered by the quote.
string
Opaque Jobber user EncodedId of the assigned salesperson.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_DISCONNECT_APPPermanently disconnect this connected account from the Jobber app, immediately revoking its access and refresh tokens. This cannot be undone; future Jobber calls require reconnecting through OAuth.

Input Parameters

boolean
required
Set to true to authorize immediate permanent revocation of this connected account’s Jobber access and refresh tokens; future calls require reconnecting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_GET_ACCOUNTReturn the connected Jobber account’s identity and basic company details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_GET_CLIENTReturn one client, its basic properties, and up to 10 normalized notes by opaque Jobber client ID. Note IDs can be passed to Update Note.

Input Parameters

string
required
Opaque Jobber EncodedId for the client, usually from List Clients.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_GET_INVOICEReturn one invoice’s receivables summary, client, salesperson, and up to 10 normalized notes by opaque Jobber invoice ID.

Input Parameters

string
required
Opaque Jobber EncodedId for the invoice, usually from List Invoices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_GET_JOBReturn one job’s status, schedule, totals, client, property, and up to 10 normalized notes by opaque Jobber job ID. Note IDs can be passed to Update Note.

Input Parameters

string
required
Opaque Jobber EncodedId for the job, usually from List Jobs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_GET_PRODUCT_OR_SERVICEReturn one catalog product, service, or labour item by opaque Jobber catalog ID. A supplied unknown catalog ID fails with Jobber’s GraphQL error because this root is non-null.

Input Parameters

string
required
Opaque Jobber EncodedId for the catalog item, usually from List Products And Services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_GET_PROPERTYReturn one service property and its owning client by opaque Jobber property ID.

Input Parameters

string
required
Opaque Jobber EncodedId for the property, usually from List Properties or Get Client.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_GET_QUOTEReturn one quote’s financial summary, client, property, salesperson, and up to 10 notes by opaque Jobber quote ID.

Input Parameters

string
required
Opaque Jobber EncodedId for the quote, usually from List Quotes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_GET_REQUESTReturn one work request and up to 10 normalized notes by opaque Jobber request ID. Note IDs can be passed to Update Note.

Input Parameters

string
required
Opaque Jobber EncodedId for the request, usually from List Requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_GET_TIME_SHEET_ENTRYReturn one time sheet entry by opaque Jobber ID.

Input Parameters

string
required
Opaque Jobber EncodedId for the time sheet entry, usually from List Time Sheet Entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_GET_USERReturn a Jobber user by ID, or the current authorized user when user_id is omitted.

Input Parameters

string
Opaque Jobber EncodedId for a user. Omit this field to return the current authorized user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_LIST_CLIENTSSearch and filter clients in the connected Jobber account, returning one cursor-paginated page.

Input Parameters

array
Return clients matching these tags.
integer
Maximum clients to return in this page (1-100).
string
Opaque next_cursor from a previous call; omit for the first page.
boolean
Filter by lead status.
string ("PRIMARY_NAME" | "UPDATED_AT" | "FIRST_NAME" | "LAST_NAME")
Field used to sort clients.
boolean
Filter company clients when true or individual clients when false.
boolean
Filter by archived state.
string
Text to match against the selected client search fields.
array
Client fields to search; omit to use Jobber’s default search behavior.
string
Return clients updated after this ISO 8601 timestamp.
string ("ASCENDING" | "DESCENDING")
Sort direction, used only when sort_key is provided.
string
Return clients updated before this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_LIST_CUSTOM_FIELD_CONFIGURATIONSList custom-field definitions by target, value type, or creating app, with type-specific defaults and one cursor page. This read was verified on Core; Jobber documents custom-field configuration features as Connect or higher.

Input Parameters

integer
Maximum custom-field definitions to return in this page (1-100).
string
Opaque next_cursor from a previous LIST_CUSTOM_FIELD_CONFIGURATIONS response.
string ("SORT_ORDER" | "CREATED_AT")
Field used to sort custom-field definitions.
string ("ALL_PROPERTIES" | "ALL_CLIENTS" | "ALL_QUOTES" | "ALL_JOBS" | "ALL_INVOICES" | "ALL_PRODUCTS_AND_SERVICES" | "TEAM")
Return definitions attached to this type of Jobber record.
string ("TEXT" | "LINK" | "AREA" | "TRUE_FALSE" | "NUMERIC" | "DROPDOWN")
Return definitions with this custom-field value type.
string ("ASCENDING" | "DESCENDING")
Direction used to sort custom-field definitions.
boolean
When set, include only definitions created by this connected app or only those created elsewhere.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_LIST_INVOICESSearch and filter invoices by client, status, or due date, returning one cursor-paginated page.

Input Parameters

integer
Maximum invoices to return in this page (1-100).
string
Opaque next_cursor from a previous LIST_INVOICES response.
string ("draft" | "awaiting_payment" | "paid" | "past_due" | "bad_debt" | "sent_not_due")
Invoice status filter.
string ("INVOICE_NUMBER" | "INVOICE_STATUS" | "CLIENT_PRIMARY_NAME" | "CREATED_AT" | "UPDATED_AT" | "ISSUED_DATE" | "DUE_DATE" | "INVOICE_TOTAL" | "INVOICE_BALANCE")
Field used to sort invoices.
string
Return invoices for this client’s opaque Jobber EncodedId.
string
Return invoices due after this ISO 8601 timestamp.
string
Return invoices due before this ISO 8601 timestamp.
string
Text used to search invoice records.
string ("ASCENDING" | "DESCENDING")
Sort direction, used only when sort_key is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_LIST_JOBSSearch and filter jobs by status, type, schedule, or assignee, returning one cursor-paginated page.

Input Parameters

integer
Maximum jobs to return in this page (1-100).
string
Opaque next_cursor from a previous LIST_JOBS response.
string ("requires_invoicing" | "archived" | "late" | "today" | "upcoming" | "action_required" | "on_hold" | "unscheduled" | "active" | "expiring_within_30_days")
Job status filter.
string ("ONE_OFF" | "RECURRING")
Filter one-off or recurring jobs.
string ("CLIENT_PRIMARY_NAME" | "UPDATED_AT" | "JOB_NUMBER" | "TOTAL_COST" | "JOB_STATUS" | "SCHEDULE" | "VISIT_START_DATE")
Field used to sort jobs.
string
Text used to search job records.
string ("ASCENDING" | "DESCENDING")
Sort direction, used only when sort_key is provided.
string
Return jobs with visits assigned to this opaque Jobber user EncodedId.
boolean
When true, return only jobs ready or eligible for invoicing.
string
Return jobs with visits scheduled after this ISO 8601 timestamp.
boolean
Include jobs without scheduled visits.
string
Return jobs with visits scheduled before this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_LIST_NOTESList one cursor page of notes for a Jobber client, job, quote, invoice, or request. An initial call requires resource_type and resource_id. Each opaque LIST_NOTES continuation retains the original resource type, resource ID, and limit, so pass only its cursor for later pages. A raw notes_next_cursor from the matching bounded GET tool requires resource_type and resource_id.

Input Parameters

integer
Maximum notes to return in this page (1-100).
string
Opaque continuation from LIST_NOTES; pass it alone to continue with its original resource type, resource ID, and limit. A raw notes_next_cursor from the matching bounded GET tool requires resource_type and resource_id.
string
Opaque Jobber EncodedId of the client, job, quote, invoice, or request. Required with resource_type for an initial call or a raw notes_next_cursor; omit for cursor-only continuation with an opaque LIST_NOTES cursor.
string ("CLIENT" | "JOB" | "QUOTE" | "INVOICE" | "REQUEST")
Type of Jobber resource whose notes to list. Required with resource_id for an initial call or a raw notes_next_cursor; omit for cursor-only continuation with an opaque LIST_NOTES cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_LIST_PRODUCTS_AND_SERVICESReturn one cursor-paginated page of catalog products, services, and labour items.

Input Parameters

integer
Maximum catalog items to return in this page (1-100).
string
Opaque next_cursor from a previous LIST_PRODUCTS_AND_SERVICES response; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_LIST_PROPERTIESSearch properties or list those belonging to a client, returning one cursor-paginated page.

Input Parameters

integer
Maximum properties to return in this page (1-100).
string
Opaque next_cursor from a previous LIST_PROPERTIES response.
boolean
Filter by whether the property is the client’s primary property.
string
Return properties owned by this opaque Jobber client EncodedId.
string
Text used to search property records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_LIST_QUOTESSearch and filter quotes by client, status, salesperson, or creation time, returning one cursor-paginated page.

Input Parameters

integer
Maximum quotes to return in this page (1-100).
string
Opaque next_cursor from a previous LIST_QUOTES response.
string ("draft" | "awaiting_response" | "archived" | "approved" | "converted" | "changes_requested")
Quote status filter.
string ("CREATED_AT" | "LAST_SENT_AT" | "QUOTE_NUMBER" | "QUOTE_STATUS" | "QUOTE_TOTAL" | "CLIENT_PRIMARY_NAME")
Field used to sort quotes.
string
Return quotes for this opaque Jobber client EncodedId.
string
Text used to search quote records.
string
Return quotes created after this ISO 8601 timestamp.
string
Return quotes created before this ISO 8601 timestamp.
string
Return quotes assigned to this opaque Jobber salesperson EncodedId.
string ("ASCENDING" | "DESCENDING")
Sort direction, used only when sort_key is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_LIST_REQUESTSSearch and filter work requests by client, property, status, assignee, or timestamp, returning one cursor-paginated page.

Input Parameters

integer
Maximum requests to return in this page (1-100).
string
Opaque next_cursor from a previous LIST_REQUESTS response.
string ("new" | "completed" | "converted" | "archived" | "upcoming" | "overdue" | "unscheduled" | "assessment_completed" | "today")
Work request status filter.
string ("TITLE" | "REQUESTED_AT" | "STATUS" | "STATUS_AND_REQUESTED_AT" | "PRIMARY_NAME" | "FIRST_NAME" | "LAST_NAME")
Field used to sort requests.
string
IANA timezone Jobber uses to calculate request status.
string
Return requests for this opaque Jobber client EncodedId.
string
Return requests for this opaque Jobber property EncodedId.
string
Text used to search work requests.
string
Return requests created after this ISO 8601 timestamp.
string
Return requests updated after this ISO 8601 timestamp.
string
Return requests created before this ISO 8601 timestamp.
string ("ASCENDING" | "DESCENDING")
Sort direction, used only when sort_key is provided.
string
Return requests updated before this ISO 8601 timestamp.
string
Return requests whose assessment is assigned to this opaque Jobber user EncodedId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_LIST_SCHEDULED_ITEMSList visits, tasks, events, assessments, and reminders for a required date-time range, optionally including unassigned or unscheduled items, one cursor-paginated page at a time.

Input Parameters

integer
Maximum scheduled items to return in this page (1-100).
string
Opaque next_cursor from a previous call; omit for the first page.
string
required
Inclusive ISO 8601 end timestamp; the window from start_at must span less than 1.5 years.
string ("ACTIVE" | "COMPLETED" | "OVERDUE" | "REMAINING")
Scheduled item status filter.
string ("COMPLETED" | "CREATED_AT" | "CLIENT_NAME" | "VALUE" | "OVERRIDE_ORDER")
Field used to sort scheduled items.
string
required
Inclusive ISO 8601 start timestamp for the scheduling window.
string ("BASIC_TASK" | "VISIT" | "EVENT" | "ASSESSMENT" | "QUOTE_REMINDER" | "INVOICE_REMINDER")
Restrict results to one scheduled item type.
string ("ASCENDING" | "DESCENDING")
Sort direction, used only when sort_key is provided.
array
Return items assigned to any of these opaque Jobber user EncodedIds.
boolean
Include items with no assigned user.
array
Control result scope: ALL includes visible scheduled, unscheduled, assigned, and unassigned items; ASSIGNMENTS includes items assigned to other visible users plus unassigned items; UNASSIGNED also includes unassigned items; UNSCHEDULED also includes unscheduled items; UNASSIGNED_ONLY returns only unassigned items and takes precedence. Omit to limit results to items assigned to the authorized user.
boolean
Include items without a scheduled time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_LIST_TIME_SHEET_ENTRIESFilter time sheet entries by user, approval, payable state, active timer, or timestamps, returning one cursor-paginated page.

Input Parameters

integer
Maximum time sheet entries to return in this page (1-100).
string
Opaque next_cursor from a previous LIST_TIME_SHEET_ENTRIES response.
boolean
Filter entries by whether their timer is currently running.
boolean
Filter entries by whether they are payable.
boolean
Filter entries by whether they are approved.
string
Return entries started after this ISO 8601 timestamp.
string
Return entries started before this ISO 8601 timestamp.
string
Return entries created after this ISO 8601 timestamp.
string
Return entries updated after this ISO 8601 timestamp.
string
Return entries active on this ISO 8601 date and time.
string
Return entries created before this ISO 8601 timestamp.
string ("ASCENDING" | "DESCENDING")
Time sheet entry sort direction.
string
Return entries updated before this ISO 8601 timestamp.
string
Return entries belonging to this opaque Jobber user EncodedId.
boolean
When true, return only entries belonging to the connected Jobber user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_LIST_USERSSearch Jobber users by name or activation status and return each user’s account status and role details in one cursor-paginated page.

Input Parameters

integer
Maximum users to return in this page (1-100).
string
Opaque next_cursor from a previous LIST_USERS response.
string ("ACTIVATED" | "DEACTIVATED")
Filter activated or deactivated users; omit to use Jobber’s default set.
array
Restrict results to these opaque Jobber user EncodedIds; requires status.
string
Text used to search users by name.
string ("ASCENDING" | "DESCENDING")
Sort users by name in this direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_LIST_VISITSFilter scheduled or unscheduled visits by status, time, assignee, or billing state, returning one cursor-paginated page.

Input Parameters

integer
Maximum visits to return in this page (1-100).
string
Opaque next_cursor from a previous LIST_VISITS response.
string ("ACTIVE" | "COMPLETED" | "LATE" | "TODAY" | "UNSCHEDULED" | "UPCOMING")
Visit status filter.
string ("CREATED_AT" | "START_AT" | "CLIENT_PRIMARY_NAME" | "STATUS")
Field used to sort visits.
string
IANA timezone Jobber uses to calculate each visit’s status.
string
Return visits starting after this ISO 8601 timestamp.
string
Return visits starting before this ISO 8601 timestamp.
string ("INVOICED_ONLY" | "UNINVOICED_ONLY")
Filter visits by whether they have been invoiced.
string ("ASCENDING" | "DESCENDING")
Visit sort direction.
string
Return visits assigned to this opaque Jobber user EncodedId.
string
Return visits containing this opaque Jobber product or service EncodedId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_UPDATE_CLIENTUpdate a Jobber client’s identity, communication preferences, or tags, or add primary email or phone details. Provide at least one update field in addition to client_id; added contact records do not replace existing records.

Input Parameters

string
required
Opaque Jobber EncodedId for the client to update.
string
Replacement last name.
string
Replacement first name.
boolean
Set whether the client represents a company.
array
Non-empty tags to add to the client.
string
Replacement company name.
string
New primary email address to add without replacing existing email records.
string
New primary phone number to add without replacing existing phone records.
array
Non-empty tags to remove from the client.
boolean
Set whether the client receives appointment reminders.
boolean
Set whether the client receives follow-up messages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_UPDATE_CUSTOM_FIELD_CONFIGURATIONRename an existing Jobber custom-field definition or update its type-specific defaults, units, or dropdown options. Requires Jobber Connect or higher and the app’s Custom Field Configurations permission; type-specific updates require the existing field type.

Input Parameters

string
Non-empty replacement custom-field name.
string
Non-empty AREA or NUMERIC unit for the selected type-specific branch.
string ("TEXT" | "LINK" | "AREA" | "TRUE_FALSE" | "NUMERIC" | "DROPDOWN")
Existing Jobber value type. Required only when sending a type-specific default, unit, or options field; it cannot change the field’s type.
string
Replacement LINK URL; requires field_type LINK and default_text.
string
Replacement TEXT default, or the required non-empty LINK label when updating a LINK default.
number
Replacement non-negative AREA default width; requires a unit.
number
Replacement non-negative AREA default length; requires a unit.
number
Replacement non-negative NUMERIC default; requires a unit.
boolean
Replacement TRUE_FALSE default. False is a valid update.
array
One to 100 unique non-empty DROPDOWN options.
string
Replacement DROPDOWN default. Supply dropdown_options in the same request, including this exact option.
string
required
Opaque Jobber EncodedId for the custom-field configuration to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_UPDATE_INVOICEUpdate an existing Jobber invoice’s customer-facing text, issue or due terms, discount, salesperson, or payment options. This is a financial write: discounts can change the invoice total, due terms can change when payment is owed, and payment switches can change how the client may pay.

Input Parameters

string
Replacement customer-facing invoice message.
string
Replacement customer-facing invoice subject.
string
Exact ISO 8601 payment due timestamp. Mutually exclusive with invoice_net_days.
string
required
Opaque Jobber EncodedId for the invoice to update.
string
Replacement ISO 8601 invoice issue timestamp.
number
Non-negative discount percentage or fixed amount; requires discount_type and can change the invoice total. Zero is preserved.
string ("Percent" | "Unit")
Whether discount_rate is a percentage or fixed unit amount.
string
Replacement account-visible invoice number.
string
Opaque Jobber user EncodedId for the salesperson.
integer
Non-negative number of days after issuance when payment is due. Mutually exclusive with due_date; zero is preserved.
boolean
Set whether the client may pay this invoice by ACH in Client Hub.
string
Replacement customer-facing contract disclaimer.
boolean
Set whether Jobber may send a review request for the invoice.
boolean
Set whether the client may make partial payments on this invoice.
boolean
Set whether the client may pay this invoice by credit card in Client Hub.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_UPDATE_JOBUpdate an existing Jobber job’s basic details, timeframe, salesperson, or review-request preference. Provide at least one update field.

Input Parameters

string
Replacement job title.
string
required
Opaque Jobber EncodedId for the job to update.
string
ISO 8601 date when the updated job timeframe starts.
string
Replacement instructions for the job team.
string ("DAYS" | "WEEKS" | "MONTHS" | "YEARS")
Unit for duration_value.
integer
Length of the updated job timeframe; requires duration_unit.
string
Opaque Jobber user EncodedId for the salesperson.
boolean
Set whether Jobber may send a review-request SMS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_UPDATE_NOTEUpdate a note discovered on a Jobber client, job, quote, invoice, or request. Dispatches only to the fixed mutation for resource_type and requires at least one supported update field. Link compatibility: CLIENT supports invoices/jobs/quotes/requests; JOB supports invoices; QUOTE supports invoices/jobs; REQUEST supports invoices/jobs/quotes; INVOICE supports no link flags.

Input Parameters

boolean
Set whether the note is pinned.
string
Replacement note text.
string
required
Opaque Jobber EncodedId for the note to update.
Set a job link for CLIENT, QUOTE, or REQUEST notes; invalid for JOB and INVOICE notes.
string ("CLIENT" | "JOB" | "QUOTE" | "INVOICE" | "REQUEST")
required
Uppercase type of Jobber resource that owns the note. Link compatibility: CLIENT supports invoices/jobs/quotes/requests; JOB supports invoices; QUOTE supports invoices/jobs; REQUEST supports invoices/jobs/quotes; INVOICE supports no link flags.
Set a quote link for CLIENT or REQUEST notes; invalid for JOB, QUOTE, and INVOICE notes.
Set an invoice link for CLIENT, JOB, QUOTE, or REQUEST notes; invalid for INVOICE notes.
Set a request link for CLIENT notes; invalid for JOB, QUOTE, REQUEST, and INVOICE notes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_UPDATE_PRODUCT_OR_SERVICEUpdate an existing Jobber catalog item’s pricing, visibility, scheduling, classification, or self-serve quantity settings. Financial fields affect the item as follows: default_unit_cost changes the default customer price, internal_unit_cost changes the internal cost used to track profitability, markup changes the markup percentage, and taxable controls whether the item is subject to tax. Provide at least one update field in addition to product_or_service_id.

Input Parameters

string
Replacement catalog item name.
number
Non-negative replacement markup percentage.
boolean
Set whether the catalog item is taxable.
boolean
Set whether the item is visible in the Jobber catalog.
string ("PRODUCT" | "SERVICE" | "LABOUR")
Replacement product, service, or labour classification.
string
Replacement catalog item description.
integer
Non-negative inclusive maximum selectable quantity; requires quantity_enabled.
integer
Non-negative inclusive minimum selectable quantity; requires quantity_enabled.
string ("WORK_ORDER" | "WORK_REQUEST")
Set whether self-serve booking creates a work order or work request.
integer
Non-negative replacement service duration in minutes.
boolean
Set whether self-serve customers may choose a quantity for this item.
number
Non-negative replacement customer unit price.
number
Non-negative replacement internal unit cost.
string
required
Opaque Jobber EncodedId for the catalog item to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBBER_UPDATE_QUOTEUpdate an existing Jobber quote’s customer-facing text, quote number, pricing modifiers, salesperson, or payment options. Provide at least one update field in addition to quote_id.

Input Parameters

string
Replacement quote title.
object
Replacement quote deposit object with required non-negative rate and type; type must be Percent for a percentage or Unit for a fixed amount.
string
Replacement customer-facing quote message.
object
Replacement quote discount object with required non-negative rate and type; type must be Percent for a percentage or Unit for a fixed amount.
string
required
Opaque Jobber EncodedId for the quote to update.
string
Replacement account-visible quote number.
string
Opaque Jobber user EncodedId for the salesperson.
boolean
Set whether the client may pay this quote by ACH in Client Hub.
string
Replacement customer-facing contract disclaimer.
boolean
Set whether the client may pay this quote by credit card in Client Hub.
boolean
Set whether the client must keep a payment method on file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not