Skip to main content
POST /api/v2/storefront/agents/{agentId}/oauth/authorize Initiates the OAuth flow for agent-level setup. The resulting tokens are stored in the agent configuration and used by the platform when it calls the agent. The response returns an authorizationUrl — send the operator there to grant consent. Use this for agents whose authenticationType is OAUTH and whose tokens are platform-scoped, not tied to a single buyer account.

​
Request

curl

​
Parameters

​
Response

Send the operator to authorizationUrl. After the publisher’s IdP authenticates and the consent flow completes, the platform stores the tokens against the agent configuration. Re-fetch the agent with Get agent to confirm authConfigured (summary) or that the oauth block is cleared.

​
Errors

  • 400 VALIDATION_ERROR — redirectUri is not a valid URI.
  • 404 NOT_FOUND — no live OAuth agent with that agentId is visible to the authenticated seller.
  • 409 CONFLICT — the public agent identity belongs to multiple live inventory sources, so the owner is ambiguous. Update the intended inventory source with its oauthAudience to start consent for that source.
See Errors for the full error contract.

Agent tasks

All agent operations

Start account OAuth

Per-account token flow instead

Get agent

Confirm auth is configured

Agents overview

OAuth flow concepts