VYG Docs
Concepts

Advocacy

Advocate programs, memberships, reward codes, attribution, campaigns and payouts.

Advocacy endpoints cover advocate programs, memberships, reward codes, order attribution, the creator directory, UGC campaigns, seeding orders and payouts.

See the Advocacy reference for every endpoint, input and response.

Who can call these

Reads work with a sign-in token or an API key that includes advocacy:read. Creating or updating advocates, memberships, codes and campaigns needs advocacy:write. Approving payouts, flagging memberships and recording A2P registration need a sign-in from a brand administrator (advocacy:admin).

If a request returns 403 insufficient_scope, advocacy is not available for your brand or your credential is missing a required scope. Contact your VYG account manager.

Records

  • Registering an advocate with an email or phone that already exists returns 409.
  • Payout amounts are calculated by the API.
  • A2P registration for advocacy SMS is separate from cart-recovery campaign registration.

On this page