Skip to main content
Auth. HMAC v1 or bearer token — see Authentication. Status. Line-dependent · Idempotent: No.
Shares the pinned line’s contact information with an existing chat. Set share_native: true for native name-and-photo sharing on enabled lines. Omitting the body retains the line’s legacy contact-card behavior. For sharing another person’s contact details, use send-contact; it is the more predictable vCard flow.

Addressing the recipient

Request

POST /api/v1/chats/{id}/share-contact-info

Response

Path parameters

string
Chat identifier. The chat must already exist and have a pinned sender line.

Body

Native name-and-photo sharing is available on enabled lines. Request it explicitly:
Optional boolean fields:
  • force: request sharing even if the line considers the contact already shared.
  • dry_run: check readiness without invoking the sharing operation.
When true, either option requires share_native:true. Lines that do not support these options return 4099 without sharing. On lines supporting the native option, omitting it retains the existing contact-card attachment behavior; it does not request the native name-and-photo handshake. Invalid JSON or non-boolean flags return HTTP 400. A dry run fails if readiness reports an unavailable operation or missing prerequisites. A successful native response can have status: "shared", "already_shared", or "dry_run_ok", with method: "nickname_handshake". shared means the native operation returned successfully; it does not confirm that the recipient saw or accepted a name-and-photo prompt. A subsequent outgoing message may be needed.

Response fields

string
The chat the line’s “Me” card was shared into.
string
"shared", "already_shared", or "dry_run_ok", depending on the requested operation.

Errors

See the full error code reference.

See also