> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # Update an affiliate > Changes an affiliate's code, rates or whether their link works. Only what is sent changes. Needs the `affiliates.write` permission (Change Affiliates). ## OpenAPI ````yaml /api-reference/openapi.json put /stores/{storeId}/affiliates/{affiliateId} openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Blacklist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}/affiliates/{affiliateId}: put: tags: - Affiliates summary: Update an affiliate description: >- Changes an affiliate's code, rates or whether their link works. Only what is sent changes. Needs the `affiliates.write` permission (Change Affiliates). operationId: affiliates.update parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string - name: affiliateId in: path required: true description: The affiliate. schema: type: string - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object properties: code: type: string description: >- What their link ends in: 2 to 40 letters, digits and dashes. One affiliate a code in a store. example: ada commission: type: number description: >- The share of each order they earn, in percent: above 0, up to 90. It is taken on what the buyer paid for the products, after every discount, before fees and tax. example: 10 discount: type: number description: >- What their link takes off for the buyer, in percent: 0 to 90. default: 0 active: type: boolean description: >- Whether their link works. Switched off, it takes nothing off and earns nothing. responses: '200': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: object properties: id: type: string customerId: type: string email: type: string code: type: string link: type: string commission: type: integer discount: type: integer active: type: boolean clicks: type: integer orders: type: integer revenue: type: integer earned: type: integer balance: type: integer requested: type: integer paidOut: type: integer paidAsCredit: type: integer joinedThemselves: type: boolean dateCreated: type: string meta: type: object properties: totals: type: object properties: affiliates: type: integer 'on': type: integer clicks: type: integer orders: type: integer revenue: type: integer earned: type: integer owed: type: integer paidOut: type: integer paidAsCredit: type: integer payouts: type: object properties: open: type: integer requested: type: integer programme: type: object properties: enabled: type: boolean defaultCommission: type: integer defaultDiscount: type: integer selfSignup: type: boolean ownLinks: type: boolean toStore: type: boolean payouts: type: boolean referred: type: integer limit: type: integer limits: type: object properties: commission: type: integer discount: type: integer code: type: integer currencyCode: type: string home: type: string example: success: true message: null code: null data: id: 7fe2bc2a-aa86-4cd0-9322-7525740509f3 customerId: f637fc21-973d-43ec-a7db-f819a9ebf73a email: ada@example.com code: ada link: https://northwind.myshoply.gg/?ref=ada commission: 20 discount: 5 active: true clicks: 0 orders: 0 revenue: 0 earned: 0 balance: 0 requested: 0 paidOut: 0 paidAsCredit: 0 joinedThemselves: false dateCreated: '2026-10-22T16:20:19Z' meta: totals: affiliates: 1 'on': 1 clicks: 0 orders: 0 revenue: 0 earned: 0 owed: 0 paidOut: 0 paidAsCredit: 0 payouts: open: 0 requested: 0 programme: enabled: true defaultCommission: 10 defaultDiscount: 5 selfSignup: false ownLinks: false toStore: true payouts: true referred: 0 limit: 500 limits: commission: 90 discount: 90 code: 40 currencyCode: USD home: https://northwind.myshoply.gg '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/Refused' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const result = await shoply.affiliates.update("AFFILIATE_ID"); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->affiliates->update('AFFILIATE_ID'); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.affiliates.update("AFFILIATE_ID") components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: >- A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with `Idempotent-Replay: true`. schema: type: string responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' Refused: description: >- The request was understood and not carried out. `validation_failed` says what is wrong with each field under `errors`; other codes are the route's own. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' schemas: Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.