Skip to main content
POST
Enrich company profile

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of enrich_linkedin_company_profile.

company_url
string
required

https://www.linkedin.com/company/{slug}/ (or a Sales Nav company URL).

Maximum string length: 2048
linkedin_account_sid
string | null

Executor account (ln_ac_...). Given: the call runs on that account ONLY. Enrichment bucket budget means charged 0; a saturated or held bucket refuses 429 bucket_saturated (with retry_after), never a silent pool charge. To pay instead, omit this and pass use_credits: true.

Required string length: 18
Pattern: ^ln_ac_
use_credits
boolean

Explicit pool opt-in (§9.5 v5.2). true with NO linkedin_account_sid: run on the platform pool and debit the method credit cost (reason infra_pool). Neither field: 422 executor_required. Both together: 422 (contradictory).

idempotency_key
string | null

Replay guard (team_sid, idempotency_key). A repeat with the same key returns the stored ledger outcome: no re-execution, no double charge.

Maximum string length: 128

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required
credits
object