Partner API

Text a company's owners

Sends an SMS to the company's owners individually — one message per owner. Omit ownerIds to text every owner on file, or pass a subset. Owners without a cell on file are skipped. STOP opt-out language is appended automatically. confirm=true and a stable idempotencyKey are required; retry the same outreach with the same key and LedgerHQ will not send it twice. Use this for general messages; bank connect/reconnect links go to a single owner via the bank-feeds endpoints.

post/companies/{companyId}/owners/text

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/companies/{companyId}/owners/text
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Path parameters

companyIdstring uuid required

LedgerHQ company UUID

Request body

messagestring required
ownerIdsstring[]

Owner ids to text; omit to text every owner

confirmtrue required

Must be true to authorize the external send

idempotencyKeystring required

Stable key for this exact outreach; reuse it on every retry

Response

Per-owner send result (sent/alreadySent/skipped/failed counts)

Changes

No recorded changes to this operation across all 5 revisions of this API.