Skip to main content

Update Success Plan Profile

PUT 
/api/success-plan/profile

Saves the profile fields you send; fields you leave out are unchanged. Sending an auto-filled field's own SKU.io value, or null, puts it back to the SKU.io value.

Required scope: success_plan:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token with the success_plan:write scope. The user must hold the success_plan.manage permission.

Body (all optional):

  • industry (string, max 160): an industry key from Get Profile Taxonomy, or other:<text>.
  • region (string): ISO country code, optionally with a subdivision (US, US-OR).
  • team_size (integer, 0–100000): people in operations.
  • previous_tools (object): job key (inventory, orders, purchasing, accounting, spreadsheets) to a previous-tool key or other:<text>. When sent, inventory and orders are required.
  • trigger (string, max 300): what made you look for something new.
  • alternatives (string array, max 15): alternative keys or other:<text>.
  • pain_quote (string, max 300): in one sentence, what was hardest before. Saved as a quote in your own words; a changed sentence becomes a new revision.
  • orders_per_month_band (string): 0-500, 500-1k, 1k-5k, 5k-20k, 20k-100k, 100k+.
  • sku_count_band (string): 0-100, 100-500, 500-2k, 2k-10k, 10k+.
  • channels (string array, max 30): lowercase channel keys such as shopify, amazon, b2b_portal.
  • fulfillment (string array, max 20): in_house, fba, wfs or 3pl:<key>.
  • accounting (string, max 40): lowercase key such as xero or quickbooks.

Returns the full profile, as Get Success Plan Profile.

Request​

Responses​

OK

Response Headers
    Content-Type