LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LinkedIn Marketing Campaign Management User Access API

7 actions 7 updates phrasing extends openapi/linkedin-user-access-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for LinkedIn's API. It is a proposal applied on top of the contract, not a document LinkedIn publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/adAccountUsers/(account:urn:li:sponsoredAccount:{SponsoredAccountId},user:urn:li:person:{PersonId})'].get
$.paths['/adAccountUsers/(account:urn:li:sponsoredAccount:{SponsoredAccountId},user:urn:li:person:{PersonId})'].put
$.paths['/adAccountUsers/(account:urn:li:sponsoredAccount:{SponsoredAccountId},user:urn:li:person:{PersonId})'].post
$.paths['/adAccountUsers/(account:urn:li:sponsoredAccount:{SponsoredAccountId},user:urn:li:person:{PersonId})'].delete
$.paths['/adAccountUsers'].get
$.paths['/organizationAcls'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for LinkedIn Marketing Campaign Management User Access API
  version: 1.0.0
extends: openapi/linkedin-user-access-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/adAccountUsers/(account:urn:li:sponsoredAccount:{SponsoredAccountId},user:urn:li:person:{PersonId})'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a member's access on an ad account
      effect: read
      questions:
      - What role does a specific person have on one ad account?
      - Can I look up a single ad account user by account and member?
      instructions:
      - text: Fetch the access of person {PersonId} on ad account {SponsoredAccountId}.
        slots:
          PersonId: path.PersonId
          SponsoredAccountId: path.SponsoredAccountId
      - text: Show which role member {PersonId} holds on account {SponsoredAccountId}.
        slots:
          PersonId: path.PersonId
          SponsoredAccountId: path.SponsoredAccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccountUsers/(account:urn:li:sponsoredAccount:{SponsoredAccountId},user:urn:li:person:{PersonId})'].put
  update:
    x-apievangelist-phrasing:
      intent: Grant a member access to an ad account
      effect: write
      questions:
      - Can I give a colleague access to my ad account with a chosen role?
      - Which role do I need to specify when adding someone to an ad account?
      instructions:
      - text: Grant person {PersonId} the {role} role on ad account {SponsoredAccountId}.
        slots:
          PersonId: path.PersonId
          role: requestBody.role
          SponsoredAccountId: path.SponsoredAccountId
      - text: Add member {user} to account {account} as {role}.
        slots:
          user: requestBody.user
          account: requestBody.account
          role: requestBody.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccountUsers/(account:urn:li:sponsoredAccount:{SponsoredAccountId},user:urn:li:person:{PersonId})'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a member's role on an ad account
      effect: write
      questions:
      - Can I change someone's existing role on an ad account?
      - Is it possible to promote an ad account viewer to campaign manager?
      instructions:
      - text: Change the role of person {PersonId} on account {SponsoredAccountId}.
        slots:
          PersonId: path.PersonId
          SponsoredAccountId: path.SponsoredAccountId
      - text: Apply patch {patch} to member {PersonId} on ad account {SponsoredAccountId}.
        slots:
          patch: requestBody.patch
          PersonId: path.PersonId
          SponsoredAccountId: path.SponsoredAccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccountUsers/(account:urn:li:sponsoredAccount:{SponsoredAccountId},user:urn:li:person:{PersonId})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from an ad account
      effect: destructive
      questions:
      - Can I revoke a person's access to my ad account?
      - What happens when I remove a user from an ad account?
      instructions:
      - text: Remove person {PersonId} from ad account {SponsoredAccountId}.
        slots:
          PersonId: path.PersonId
          SponsoredAccountId: path.SponsoredAccountId
      - text: Revoke member {PersonId}'s access to account {SponsoredAccountId}.
        slots:
          PersonId: path.PersonId
          SponsoredAccountId: path.SponsoredAccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccountUsers'].get
  update:
    x-apievangelist-phrasing:
      intent: List ad accounts the current user can access
      effect: read
      questions:
      - Which ad accounts do I personally have access to?
      - Can I see every ad account my token's member belongs to?
      instructions:
      - text: List all ad accounts I have access to using API version {version}.
        slots:
          version: header.LinkedIn-Version
      - text: Show the ad accounts the authenticated member is a user on.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizationAcls'].get
  update:
    x-apievangelist-phrasing:
      intent: List the current user's organization roles
      effect: read
      questions:
      - Which company pages am I an administrator of?
      - Can I retrieve my own roles across organizations on LinkedIn?
      instructions:
      - text: List my organization roles using API version {version}.
        slots:
          version: header.LinkedIn-Version
      - text: Show which organizations the authenticated user manages.
      method: generated
      generated: '2026-09-26'