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

# Update a record

> Updates an existing record. Field values are sent **flat** at the top level — only the fields you include are changed.

Update a record

**Permission:** Requires `manage_custom_objects` **or** `manage_custom_records`. Denials read `Manage Custom Records`.



## OpenAPI

````yaml /api-reference/specs/custom-object-records.json put /api/custom/records/{id}
openapi: 3.1.0
info:
  title: ConveYour API — Custom Object Records
  description: Create, retrieve, update, and delete records for your Custom Object types.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Custom Object Records
    description: Create, retrieve, update, and delete records for your Custom Object types.
paths:
  /api/custom/records/{id}:
    put:
      tags:
        - Custom Object Records
      summary: Update a record
      description: >-
        Updates an existing record. Field values are sent **flat** at the top
        level — only the fields you include are changed.


        Update a record


        **Permission:** Requires `manage_custom_objects` **or**
        `manage_custom_records`. Denials read `Manage Custom Records`.
      operationId: updateARecord
      parameters:
        - name: id
          in: path
          required: true
          description: The id identifier.
          schema:
            type: string
        - $ref: '#/components/parameters/teams'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                ...:
                  description: >-
                    The field values to update, sent flat at the top level. Only
                    provided fields are changed. There is no `data` wrapper.
                  type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/CustomRecord'
              example:
                status: ok
                message: Custom Record updated
                data:
                  id: 64a1b2c3d4e5f6a7b8c9d0e1
                  obj_id: OBJECT_ID
                  external_id: vin-123
                  make: Ford
                  model: F-150
                  year: 2023
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    CustomRecord:
      type: object
      description: >-
        A custom object record. The field set varies per organization and per
        object: the parent object's stored schema is merged over the defaults.
      properties:
        id:
          type: string
          description: Record ID.
        obj_id:
          type: string
          description: Parent custom object. Required — the record is rejected without it.
        obj_name:
          type: string
          description: Parent object name.
        external_id:
          type: string
          description: Your identifier. Bulk upserts match on this.
        org_id:
          type: integer
          description: Owning organization.
        contact_id:
          type: string
          description: Linked contact, for non-standalone objects.
        created_at:
          type: integer
          description: Unix timestamp.
        updated_at:
          type: integer
          description: Unix timestamp.
        changed_at:
          type: integer
          description: Unix timestamp of the last value change.
      required:
        - obj_id
      additionalProperties:
        description: Any field defined on the parent custom object's schema.
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
    NotFound:
      description: No record matched the supplied ID.
      content:
        application/json:
          example:
            status: failed
            message: Contact not found
            data: []
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

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