> ## 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.

# Change the link's code

> What the affiliate's link ends in, where the store lets affiliates choose it. The old link stops working. Answers the affiliate page.

Needs the buyer's token: `Authorization: Bearer shoply_ct_...`, from Sign in with the code.

It is counted for the buyer's token: 30 changes in ten minutes.



## OpenAPI

````yaml /api-reference/openapi.json put /stores/{storeId}/customer/affiliate/link
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}/customer/affiliate/link:
    put:
      tags:
        - Customer API
      summary: Change the link's code
      description: >-
        What the affiliate's link ends in, where the store lets affiliates
        choose it. The old link stops working. Answers the affiliate page.


        Needs the buyer's token: `Authorization: Bearer shoply_ct_...`, from
        Sign in with the code.


        It is counted for the buyer's token: 30 changes in ten minutes.
      operationId: customer.affiliate.link
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID, from Settings, General in its dashboard. It is not a
            secret: a page may show it.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                code:
                  type: string
                  description: >-
                    What the link ends in: letters, digits and dashes, as long
                    as `limits` on the affiliate page says. One affiliate a code
                    in a store.
                  example: ada
              required:
                - code
      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:
                      member:
                        type: boolean
                      canJoin:
                        type: boolean
                      offered:
                        type: object
                        properties:
                          commission:
                            type: integer
                          discount:
                            type: integer
                      active:
                        type: boolean
                      code:
                        type: string
                      link:
                        type: string
                      linkStart:
                        type: string
                      commission:
                        type: integer
                      discount:
                        type: integer
                      clicks:
                        type: integer
                      orders:
                        type: integer
                      earned:
                        type: object
                        properties:
                          amount:
                            type: integer
                          currencyCode:
                            type: string
                      balance:
                        type: object
                        properties:
                          currencyCode:
                            type: string
                          amount:
                            type: number
                      paidOut:
                        type: object
                        properties:
                          amount:
                            type: integer
                          currencyCode:
                            type: string
                      can:
                        type: object
                        properties:
                          editLink:
                            type: boolean
                          toStore:
                            type: boolean
                          payouts:
                            type: boolean
                      payout:
                        nullable: true
                      payouts:
                        type:
                          - array
                          - object
                      changes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            kind:
                              type: string
                            amount:
                              type: number
                            balanceAfter:
                              type: number
                            currencyCode:
                              type: string
                            dateCreated:
                              type: string
                      limits:
                        type: object
                        properties:
                          codeMin:
                            type: integer
                          codeMax:
                            type: integer
                          details:
                            type: integer
              example:
                success: true
                message: null
                code: null
                data:
                  member: true
                  canJoin: false
                  offered:
                    commission: 10
                    discount: 5
                  active: true
                  code: ada-keys
                  link: https://northwind.myshoply.gg/?ref=ada-keys
                  linkStart: https://northwind.myshoply.gg/?ref=
                  commission: 20
                  discount: 5
                  clicks: 0
                  orders: 0
                  earned:
                    amount: 0
                    currencyCode: USD
                  balance:
                    amount: 12.5
                    currencyCode: USD
                  paidOut:
                    amount: 0
                    currencyCode: USD
                  can:
                    editLink: true
                    toStore: true
                    payouts: true
                  payout: null
                  payouts: []
                  changes:
                    - id: 6b4221ce-60ee-4856-99c2-8efe0af9321b
                      kind: add
                      amount: 12.5
                      balanceAfter: 12.5
                      currencyCode: USD
                      dateCreated: '2026-10-22T16:20:19Z'
                  limits:
                    codeMin: 2
                    codeMax: 40
                    details: 300
        '401':
          $ref: '#/components/responses/NoToken'
        '403':
          $ref: '#/components/responses/StoreSaysNo'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Refused'
        '429':
          $ref: '#/components/responses/CustomerTooMany'
      security:
        - customerToken: []
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: >
            import { ShoplyCustomer } from "@shoplygg/node";


            const buyer = new ShoplyCustomer({ storeId: "YOUR_STORE_ID", token
            });


            const result = await buyer.affiliate.link({
              code: "ada",
            });
        - lang: php
          label: PHP
          source: >
            <?php


            require 'vendor/autoload.php';


            $buyer = new Shoply\Customer(['storeId' => 'YOUR_STORE_ID', 'token'
            => $token]);


            $result = $buyer->affiliate->link([
                'code' => 'ada',
            ]);
        - lang: python
          label: Python
          source: |
            import shoply

            buyer = shoply.Customer("YOUR_STORE_ID", token=token)

            result = buyer.affiliate.link(code="ada")
components:
  responses:
    NoToken:
      description: >-
        No buyer's token was sent, or it was an API key
        (`customer_token_required`), or the token has ended or is another
        store's (`invalid_customer_token`). Sign the buyer in again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    StoreSaysNo:
      description: >-
        The store does not let a buyer do this itself: `cancel_off`, `undo_off`,
        `pause_off`, `affiliates_closed`. Its customer panel says the same.
      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'
    CustomerTooMany:
      description: >-
        Too many requests for now: `rate_limited`, or the route's own
        (`code_cooldown`, `code_paused`, `store_busy`). `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_...`
    customerToken:
      type: http
      scheme: bearer
      description: >-
        A buyer's token, from Sign in with the code: `Authorization: Bearer
        shoply_ct_...`. It reaches that buyer's own orders at one store, and no
        route that takes a key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.