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

# Update Object Access

> Share a custom object type with your staff: a role for everyone, roles for people and teams, and a
filter on the records non-admins reach. A new type is only visible to its creator and to administrators.
Requires the admin role on the type.



## OpenAPI

````yaml /openapi-v1.json put /api/v1/crm/objects/{type_key}/access
openapi: 3.1.0
info:
  title: AGO Public API
  version: 1.0.0
  description: Programmatic access to your AGO workspace.
servers:
  - url: https://{tenant_id}.api.useago.com
    description: AGO Public API v1
    variables:
      tenant_id:
        default: your-tenant-id
        description: Your AGO tenant identifier
security: []
paths:
  /api/v1/crm/objects/{type_key}/access:
    put:
      tags:
        - CRM objects
      summary: Update Object Access
      description: >-
        Share a custom object type with your staff: a role for everyone, roles
        for people and teams, and a

        filter on the records non-admins reach. A new type is only visible to
        its creator and to administrators.

        Requires the admin role on the type.
      operationId: update_crm_object_access
      parameters:
        - in: path
          name: type_key
          schema:
            title: Type Key
            type: string
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObjectAccessIn'
        required: true
      responses:
        '200':
          description: OK
      security:
        - ScopedAPIKeyAuth: []
components:
  schemas:
    ObjectAccessIn:
      properties:
        default_role:
          anyOf:
            - type: string
            - type: 'null'
          description: 'What every active staff member may do: '''' (nothing), read or write'
          title: Default Role
        grants:
          anyOf:
            - items:
                $ref: '#/components/schemas/ObjectGrantIn'
              type: array
            - type: 'null'
          description: Replaces the roles given to people and teams
          title: Grants
        row_filter:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: >-
            Filter that the records a non-admin reads or writes must match;
            "$me" is that person's id, e.g. {"owner": "$me"}. {} removes it.
          title: Row Filter
      title: ObjectAccessIn
      type: object
    ObjectGrantIn:
      properties:
        user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: User Id
        team_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Team Id
        role:
          description: read, write or admin
          title: Role
          type: string
      required:
        - role
      title: ObjectGrantIn
      type: object
  securitySchemes:
    ScopedAPIKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````

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