> ## 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 Hubspot Sync

> Turn the HubSpot sync on or off and set which HubSpot object goes to which object type, property by
property. Administrators only; the sync then writes as the user who saved it.



## OpenAPI

````yaml /openapi-v1.json put /api/v1/crm/sync/hubspot
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/sync/hubspot:
    put:
      tags:
        - CRM objects
      summary: Update Hubspot Sync
      description: >-
        Turn the HubSpot sync on or off and set which HubSpot object goes to
        which object type, property by

        property. Administrators only; the sync then writes as the user who
        saved it.
      operationId: update_crm_hubspot_sync
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HubSpotSyncIn'
        required: true
      responses:
        '200':
          description: OK
      security:
        - ScopedAPIKeyAuth: []
components:
  schemas:
    HubSpotSyncIn:
      properties:
        enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Enabled
        mappings:
          anyOf:
            - items:
                $ref: '#/components/schemas/HubSpotMappingIn'
              type: array
            - type: 'null'
          title: Mappings
      title: HubSpotSyncIn
      type: object
    HubSpotMappingIn:
      properties:
        external_object:
          description: companies, contacts, deals or a HubSpot custom object id
          title: External Object
          type: string
        object_type:
          description: Object type receiving the records
          title: Object Type
          type: string
        properties:
          type: object
          additionalProperties:
            type: string
          description: HubSpot property name -> attribute key
          title: Properties
        write_back:
          default: false
          description: >-
            Also send the changes made in AGO back to the HubSpot records they
            came from
          title: Write Back
          type: boolean
      required:
        - external_object
        - object_type
        - properties
      title: HubSpotMappingIn
      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.