Skip to main content
POST
Attempt IM person linking

Restrictions

Usage

  • Looks up every account member not yet linked to this integration’s IM app by email and phone; only Feishu, DingTalk and WeCom integrations are supported, other types return InvalidParameter.
  • A disabled integration returns InvalidParameter.
  • Returns RequestLocked while another linking run for the same integration is in progress, and InvalidParameter when the IM platform refuses the lookup (missing contact permissions or rejected credentials).
  • new_linked_person_ids is an empty array when nobody could be newly linked.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Parameters for attempting automatic IM account linking.

integration_id
integer<int64>
required

IM integration ID; obtain it from POST /datasource/im/war-room-enabled/list.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Result of one linking run for the integration.