Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Company Api → Patch Api Crm Companies Company

AI-generated

Summary

Patch an existing company in the Contractors.es CRM by specifying the company ID and providing only the fields to update. Fields left as the sentinel value 'DO_NOT_UPDATE' are not changed.

Inputs

  • Company (required) — The numeric ID of the company to update.
  • Company Name — The updated company name. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Short Name — The updated short name for the company. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Phone — The updated phone number of the company. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Fax — The updated fax number of the company. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Email — The updated email address of the company. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Web Address — The updated web address (website) of the company. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Address 1 — The updated first address line. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Address 2 — The updated second address line. Leave as 'DO_NOT_UPDATE' to skip updating.
  • City — The updated city. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Country Id — The updated country ID code. Leave as 'DO_NOT_UPDATE' to skip updating.
  • State Id — The updated state ID code. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Postcode — The updated postal code. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Tax Id — The updated tax identifier. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Memo — The updated memo or notes field. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Default Hour Rate — The updated default hourly rate for the company. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Default Hour Rate Currency — The updated currency for the default hourly rate. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Salary Custom Percentages — Custom salary percentages to update. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Salary Secondary Percentage — Updated secondary salary percentage. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Overtime Primary Percentage — Updated primary overtime percentage. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Overtime Secondary Percentage — Updated secondary overtime percentage. Leave as 'DO_NOT_UPDATE' to skip updating.
  • Permission — Updated permission level (1 - public, 2 - public read-only, 3 - private). Leave as 'DO_NOT_UPDATE' to skip updating.
  • External Id — Updated external identifier. Leave as 'DO_NOT_UPDATE' to skip updating.

Output shape

a JSON object representing the updated company resource as returned by the Contractors.es API after patching.

Only the fields sent with values different from the sentinel 'DO_NOT_UPDATE' will be patched; others are omitted from the patch request body. The response will contain the updated company details.

Examples

Example 1: Update a company's name and phone by specifying the company ID and new values, leaving other fields as 'DO_NOT_UPDATE' to keep them unchanged.

Set 'Company' to the target company ID, 'Company Name' to the new name, 'Phone' to the new phone number, and leave all other fields as 'DO_NOT_UPDATE'.

Links

Discussion