Attach an uploaded file to a record

Links a previously uploaded file (see the upload-URL endpoint) to the record and returns the updated record.

Authorization

apiKey

Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

object*string

The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).

id*string

The unique ID of the record.

Query Parameters

silent?boolean

When true, suppresses in-app and Slack notifications for this mutation.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

The file name, including its extension.

key*string

The storage key returned by the signed-upload-URL request.

attachmentId*string

The attachment ID returned by the signed-upload-URL request.

Response Body

`application/json`

curl -X POST "https://example.com/workspaces/string/objects/string/records/string/attachments" \  -H "Content-Type: application/json" \  -d '{    "name": "proposal.pdf",    "key": "attachments/acme/person/3b9f5c7d-6e2a-4f8b-9d1c-0a7e5b3f9d24/proposal.pdf",    "attachmentId": "3b9f5c7d-6e2a-4f8b-9d1c-0a7e5b3f9d24"  }'

{
  "data": {
    "type": "person",
    "id": "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71",
    "attributes": {
      "_id": "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71",
      "name": {
        "first_name": "Jane",
        "last_name": "Doe"
      },
      "email_addresses": {
        "items": [
          "jane@acme.com"
        ]
      },
      "job_title": "VP of Marketing",
      "company_id": "c0a80121-7ac0-4b1c-8b6d-3e5f9a2d4c88",
      "_created_at": "2026-01-15T09:30:00.000Z",
      "_updated_at": "2026-02-01T17:45:00.000Z"
    }
  }
}