Skip to content

Create File Links

Create the specified file links.

Verb PUT
Endpoint {base-url}/files/links
Max Page Size N/A

Request Body

{
  "body": [
    {
      "fileId": 2,
      "linkedRecordId": 1,
      "linkedRecordType": 2
    }
  ]
}

Note

All changes in this request are atomic. If any item fails, the entire batch is rolled back and no changes are made.

Returns

On Success

Return the IDs of the created file links.

Response Body

Response Body
[
  2
]

On Error

HTTP Code Error Code Definition
422 VALIDATION_ERROR A required field is missing or invalid (e.g. fileId is missing or less than 1, linkedRecordId is missing or less than 1, linkedRecordType is missing).
403 DATA_ACCESS_VIOLATION One or more of the specified linked records, or the specified fileId, belong to an organization you do not have access to.
404 MISSING_RECORD One or more of the specified linkedRecordId values, or the specified fileId, does not exist.