Checkmob icon

Checkmob

Interact with the Checkmob Field Service API v2

Segment → Link Client

AI-generated

Summary

Links a Checkmob client to a segment.

Inputs

  • segmentLinkId (required) — The ID of the segment to link the client to.
  • segLinkedIdClient (required) — The ID of the client to link.
  • language — The language of the error messages returned by the API (default: pt-BR).

Output shape

The response from the Checkmob API.

The operation consumes the configured credentials and makes a POST request to the Checkmob API to establish the link. The returned data is passed through as-is.

Examples

Example 1: Link an existing client (ID 42) to a specific segment (ID 10) using Portuguese error messages.

Set segmentLinkId to 10, segLinkedIdClient to 42, and language to pt-BR.

Example 2: Link a client to a segment using English error messages.

Set segmentLinkId and segLinkedIdClient to the relevant IDs, and language to en-US.

Links

Discussion