---
descriptions:
  update_resource_by_external_id:
    organization_id: The ID of the organization.
    resource_type_slug: The slug of the resource type.
    external_id: The external ID of the resource.
    name: The new name for the resource.
    description: The new description for the resource. Pass null to remove the description.
reference:
  curl:
    - key: update_resource_by_external_id
      id: update_resource_by_external_id
      url: /reference/fga/resource/update-by-external-id
      title: >-
        /authorization/organizations/:organization_id/resources/:resource_type_slug/:external_id
      type: PATCH
      parameters:
        - key: organization_id
          type: string
          description: (update_resource_by_external_id.organization_id)
        - key: resource_type_slug
          type: string
          description: (update_resource_by_external_id.resource_type_slug)
        - key: external_id
          type: string
          description: (update_resource_by_external_id.external_id)
        - key: name
          type: string
          optional: true
          description: (update_resource_by_external_id.name)
        - key: description
          type: string | null
          optional: true
          description: (update_resource_by_external_id.description)
      returns:
        - (resource)
  js:
    - key: updateResourceByExternalId
      id: update_resource_by_external_id
      url: /reference/fga/resource/update-by-external-id
      title: authorization.updateResourceByExternalId()
      parameters:
        - key: options
          type: object
          unwrap: true
          properties:
            - key: organizationId
              type: string
              description: (update_resource_by_external_id.organization_id)
            - key: resourceTypeSlug
              type: string
              description: (update_resource_by_external_id.resource_type_slug)
            - key: externalId
              type: string
              description: (update_resource_by_external_id.external_id)
            - key: name
              type: string
              optional: true
              description: (update_resource_by_external_id.name)
            - key: description
              type: string | null
              optional: true
              description: (update_resource_by_external_id.description)
      returns:
        - key: AuthorizationResource
          description: (resource.self)
originalPath: >-
  .tmp-workos-clone/packages/docs/content/reference/fga/resource/update-by-external-id.mdx
---

## Update a resource by external ID

Update an existing authorization resource using its external ID. Only the fields provided will be updated.

<CodeBlock referenceId="update_resource_by_external_id">
  <CodeBlockTab title="Request" file="update-resource-by-external-id-request" />
  <CodeBlockTab
    title="Response"
    file="update-resource-by-external-id-response"
  />
</CodeBlock>
