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

# Update an organization

> Its name or description. Needs a key with the `admin` scope.



## OpenAPI

````yaml /openapi.json patch /api/v1/organizations/{id}/
openapi: 3.0.3
info:
  title: Go-Fetch API
  version: v1
servers:
  - url: https://go-fetch.io
security: []
tags:
  - name: Jobs
    description: >-
      A job is one scrape. Create it with a scraper type and its input, follow
      it until it is completed, failed, timed_out or cancelled, then page
      through its results.
  - name: Webhooks
    description: >-
      URLs we POST to when a job finishes, signed with your webhook secret in
      the X-Webhook-Signature header, and the log of every delivery.
  - name: Usage
    description: Billable usage, one record per charge.
  - name: Pricing
    description: List prices per platform and a cost estimate. No API key needed.
  - name: API keys
    description: >-
      Your organization's API keys. Creating, changing and rotating a key needs
      a key with the admin scope.
  - name: Organizations
    description: >-
      The organization your key belongs to: its environments, members, this
      month's usage and the audit log.
paths:
  /api/v1/organizations/{id}/:
    patch:
      tags:
        - Organizations
      summary: Update an organization
      description: Its name or description. Needs a key with the `admin` scope.
      operationId: organizations_partial_update
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedOrganizationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedOrganizationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedOrganizationRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
          description: ''
      security:
        - ApiKeyAuth: []
components:
  schemas:
    PatchedOrganizationRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
        description:
          type: string
    Organization:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          maxLength: 255
        slug:
          type: string
          readOnly: true
          pattern: ^[-a-zA-Z0-9_]+$
        description:
          type: string
        credit_balance:
          type: string
          format: decimal
          pattern: ^-?\d{0,8}(?:\.\d{0,4})?$
          readOnly: true
          description: Current credit balance (USD). Prepaid credits for scraping.
        low_balance_threshold:
          type: string
          format: decimal
          pattern: ^-?\d{0,8}(?:\.\d{0,4})?$
          readOnly: true
        status:
          allOf:
            - $ref: '#/components/schemas/OrganizationStatusEnum'
          readOnly: true
        is_over_limit:
          type: boolean
          description: True once the credit balance is at or below zero.
          readOnly: true
        member_count:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - created_at
        - credit_balance
        - id
        - is_over_limit
        - low_balance_threshold
        - member_count
        - name
        - slug
        - status
        - updated_at
    OrganizationStatusEnum:
      enum:
        - active
        - suspended
        - cancelled
      type: string
      description: |-
        * `active` - Active
        * `suspended` - Suspended
        * `cancelled` - Cancelled
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````

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