> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firstpromoter.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Change payouts status

> This call allows you to change the status of the payout. For example, you can mark the payout as completed once it has been paid.



## OpenAPI

````yaml openapi-payouts PUT /update
openapi: 3.0.1
info:
  title: FirstPromoter Payouts API
  description: >-
    The Payouts API lets you list and change the payouts status of your
    promoters.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://firstpromoter.com/api/v1/payouts
security:
  - apiKeyAuth: []
paths:
  /update:
    put:
      description: >-
        This call allows you to change the status of the payout. For example,
        you can mark the payout as completed once it has been paid.
      parameters:
        - name: id
          in: query
          required: true
          description: ID of payout inside FirstPromoter
          schema:
            type: string
        - name: status
          in: query
          description: The new payout status.
          schema:
            type: string
            enum:
              - pending
              - processing
              - completed
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 2710287
                  status:
                    type: string
                    example: completed
                  amount:
                    type: integer
                    example: 3000
                  date_paid:
                    type: string
                    format: date-time
                    nullable: true
                    example: null
                  due_date:
                    type: string
                    format: date-time
                    example: '2024-10-11T00:00:00.000Z'
                  unit:
                    type: string
                    example: cash
                  created_at:
                    type: string
                    format: date-time
                    example: '2024-09-12T14:02:53.135Z'
                  has_issues:
                    type: boolean
                    example: false
                  reward:
                    type: object
                    nullable: true
                    example: null
                  promoter:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 8262622
                      status:
                        type: string
                        example: active
                      cust_id:
                        type: string
                        example: ''
                      email:
                        type: string
                        example: test@promoter.com
                      created_at:
                        type: string
                        format: date-time
                        example: '2024-05-27T17:43:38.935Z'
                      temp_password:
                        type: string
                        example: xsKyiS
                      default_promotion_id:
                        type: integer
                        example: 9441115
                      pref:
                        type: string
                        example: w4wfj9q
                      default_ref_id:
                        type: string
                        example: testxeak1xz1
                      note:
                        type: string
                        example: >-
                          This is a test promoter. You can use it to test the
                          integration.
                      w8_form_url:
                        type: string
                        nullable: true
                        example: null
                      w9_form_url:
                        type: string
                        nullable: true
                        example: null
                      parent_promoter_id:
                        type: integer
                        nullable: true
                        example: null
                      earnings_balance:
                        type: object
                        properties:
                          cash:
                            type: integer
                            example: 23000
                      current_balance:
                        type: object
                        properties:
                          cash:
                            type: integer
                            example: 23000
                      paid_balance:
                        type: object
                        nullable: true
                        example: null
                      auth_token:
                        type: string
                        example: bFahsKx8v9_zL9sPTZCDH8JnQAbTeDpy
                  campaign:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 15161
                      name:
                        type: string
                        example: Test new campaign
                      landing_url:
                        type: string
                        example: http://testmax.maxwelladapoe1.com/
                      description:
                        type: string
                        example: ''
                      private:
                        type: boolean
                        example: false
                      color:
                        type: string
                        example: '#00bcd4'
                      default_webhook_url:
                        type: string
                        example: ''
                      auto_approve_rewards:
                        type: boolean
                        example: true
                      auto_approve_promoters:
                        type: boolean
                        example: true
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Payment not found
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: You need to find the payout by id.
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````