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

# Amend a distribution

> Publisher side only. Suspends, restores or revokes a distribution and grants or withdraws products. Revoked is terminal. Supply at least one of `status`, `grant_products` or `withdraw_products`. Root and admin roles only.



## OpenAPI

````yaml /api-reference/endpoint/distribution/openapi.json patch /accounts/distribution
openapi: 3.1.0
info:
  title: quiva.ai Distribution API
  description: >-
    API for distributing products from a publisher account to distributor
    accounts: invitations, the distribution register, product definitions,
    messages between the two sides and config id reservations.
  version: 1.0.0
  contact:
    name: quiva.ai Support
    url: https://app.quiva.ai
servers:
  - url: https://api.quiva.ai
    description: Production API server
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Distribution Invitations
    description: >-
      Mint, deliver, preview and redeem invitations that connect a distributor
      to a publisher
  - name: Distribution Register
    description: The register of distributions between a publisher and its distributors
  - name: Distributor Setup
    description: Distributor features, space template and space bindings
  - name: Distribution Products
    description: Product definitions and the products a distributor may work under
  - name: Distribution Messages
    description: Messages sent between the two sides of a distribution
  - name: Config Reservations
    description: Reservations of record config ids
paths:
  /accounts/distribution:
    patch:
      tags:
        - Distribution Register
      summary: Amend a distribution
      description: >-
        Publisher side only. Suspends, restores or revokes a distribution and
        grants or withdraws products. Revoked is terminal. Supply at least one
        of `status`, `grant_products` or `withdraw_products`. Root and admin
        roles only.
      operationId: amendDistribution
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AmendDistributionRequest'
      responses:
        '200':
          description: Distribution updated
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    properties:
                      distribution:
                        $ref: '#/components/schemas/Distribution'
                      previous_status:
                        type: string
                      previous_products:
                        type: array
                        items:
                          type: string
                      active_products:
                        type: array
                        items:
                          type: string
                      steps:
                        type: array
                        items:
                          $ref: '#/components/schemas/ProvisioningStep'
                      note:
                        type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No distribution with that distributor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            A work-item product cannot be granted to a distribution with no
            service desk.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributionRefusalResponse'
components:
  schemas:
    AmendDistributionRequest:
      type: object
      properties:
        distributor_account_id:
          type: string
        status:
          type: string
          enum:
            - active
            - suspended
            - revoked
        reason:
          type: string
        grant_products:
          type: array
          items:
            $ref: '#/components/schemas/InviteProduct'
        withdraw_products:
          type: array
          items:
            type: string
      required:
        - distributor_account_id
    Distribution:
      type: object
      description: 'One register entry: a grant from a publisher to a distributor.'
      properties:
        publisher_account_id:
          type: string
        distributor_account_id:
          type: string
        distributor_name:
          type: string
        publisher_name:
          type: string
        distribution_id:
          type: string
        products:
          type: array
          items:
            type: object
            additionalProperties: true
        status:
          type: string
          enum:
            - pending
            - active
            - suspended
            - revoked
          description: Lifecycle state of the grant
        status_reason:
          type: string
        scope:
          type: array
          items:
            type: string
        provisioning_state:
          type: string
        space_id:
          type: string
        publisher_space_id:
          type: string
        distributor_space_id:
          type: string
        record_config_ids:
          type: array
          items:
            type: string
        invite_id:
          type: string
        granted_by:
          type: string
        requested_by:
          type: string
        effective_from:
          type: string
        effective_to:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
      additionalProperties: true
    ProvisioningStep:
      type: object
      properties:
        name:
          type: string
        done:
          type: boolean
        detail:
          type: string
      required:
        - name
        - done
    Error:
      type: object
      properties:
        error:
          type: string
    DistributionRefusalResponse:
      type: object
      description: >-
        A refusal by the distribution register. `refusal_code` names the reason
        so a caller can branch on it.
      properties:
        data:
          type: object
          properties:
            status:
              type: string
              description: Always `refused`
            refusal_code:
              type: string
            detail:
              type: string
    InviteProduct:
      type: object
      properties:
        product_id:
          type: string
        version:
          type: string
          description: Empty tracks the latest version
        product_name:
          type: string
        type:
          type: string
        commission_cap:
          type: number
          description: Per-product cap, a percentage
        clear_commission_cap:
          type: boolean
      required:
        - product_id
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

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