Skip to main content
POST
Preview post engagement

Authorizations

Authorization
string
header
required

Access token issued by gs.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 preview_post_engagement.

url
string<uri>
required

A post link (/posts/…, /feed/update/…, a lnkd.in shortlink), a profile link (/in/{slug}) or a company page link (/company/{slug}); any other link is 422 link_not_recognized.

Maximum string length: 2048
sender_profile_sid
string
required

The sender profile whose LinkedIn account reads the link (ub_sp_), the one the source will run on; one that cannot read LinkedIn now is 422 with gtm's reason. A busy seat is 409 preview_unavailable (context.retry_after_seconds): create still works.

Required string length: 18
Pattern: ^ub_sp_

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