Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Company Group Relation Api → Patch Api Crm Companies Company Groups Group Pivot

AI-generated

Summary

Patches a company's group membership on Contractors.es by sending a partial update to the group pivot endpoint.

Inputs

  • company (required) — The ID of the company to update.
  • group (required) — The ID of the group to add the company to.
  • pivot — A JSON object containing specific fields to update on the pivot record. Sending 'DO_NOT_UPDATE' or 'DO_NOT_SET' omits the entire payload, leaving the pivot unchanged.
  • requestOptions — Options for HTTP requests including batching, timeouts, and proxy settings.

Output shape

A single item containing the API response for the patched pivot record.

If the pivot payload is omitted or sent as a sentinel string, the operation performs a no-op update (sends an empty body).

Examples

Example 1: Add a company to a group without changing other pivot fields.

Company ID: 5, Group ID: 2, Pivot: DO_NOT_UPDATE

Example 2: Update a specific field on the company's group pivot.

Company ID: 5, Group ID: 2, Pivot: { 'some_field': 'new_value' }

Links

Discussion