Attach a file to a lead

POST

https://api.close.com/api/v1/lead/:id/files/

POST

/api/v1/lead/:id/files/

curl -X POST https://api.close.com/api/v1/lead/id/files/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "content_type": "application/pdf",
  "filename": "contract.pdf",
  "url": "https://app.close.com/go/file/temporary/user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk/1Zx0AlY1DwBXzKKrVwpAoj/contract.pdf/"
}'

{
  "checksum": "d41d8cd98f00b204e9800998ecf8427e",
  "content_type": "application/pdf",
  "date_created": "2024-03-07T16:07:00+00:00",
  "date_updated": "2024-03-07T16:07:00+00:00",
  "download_url": "https://app.close.com/go/file/persisted/orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH/activity.email/acti_5rV2n1Ub/1Zx0AlY1DwBXzKKrVwpAoj/contract.pdf/",
  "id": "file_2Lm4kZ8Qqwe0rTaPnB6yXcVd9sHgKfJoMuIlN3vBz1A",
  "is_pinned": false,
  "last_activity_at": "2024-03-07T16:07:00+00:00",
  "last_object_id": "acti_5rV2n1UbQ8mLkJhGfDsAwErTyUiOpZxCvBnM3aQ",
  "last_object_type": "activity.email",
  "lead_id": "lead_70jZ5hiVt5X31MZ3vJ0R0GJMqJEihkoF7TtSVFbN2ty",
  "name": "contract.pdf",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "size": 20480,
  "thumbnail_url": null,
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}

Attach an already-uploaded file to a lead. First upload the file to S3 using the Files API, then pass the resulting download url here along with its filename and content_type.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects an object.

content_typestringRequired1-255 characters

filenamestringRequired1-1024 characters

urlstringRequired>=1 character

Response

Successful response

checksumstring

content_typestring

date_createddatetime

date_updateddatetime

download_urlstring

idstring

is_pinnedboolean

last_activity_atdatetime

last_object_idstring

last_object_typestring

lead_idstring

namestring

organization_idstring

sizeinteger

thumbnail_urlstring or null

updated_bystring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error