File

patch

https://api.marketcircle.net/v1/files/{id}

Update a file

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Updates a file's details and links. Attributes you leave out are not changed. To change a file's content, create a new file; content can only be uploaded once.

A file in the trash can't be edited (404 with {"error":"trashed_object"}) until you restore it with {"trashed": false}. A successful update returns 204 No Content.

Path Params

int32

required

The file ID

Body Params

name

string

File name, including the extension, e.g. proposal.pdf. Used as the file name when the content is downloaded.

title

string

Title shown in Daylite.

extension

string

File extension without the dot, e.g. pdf. Sets the content type when the file is downloaded.

note

string

Description of the file.

appointments

Appointments linked to the file. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

contacts

Contacts linked to the file. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

companies

Companies linked to the file. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

opportunities

Opportunities linked to the file. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

projects

Projects linked to the file. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

tasks

Tasks linked to the file. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

groups

Groups linked to the file. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

notes

Notes linked to the file. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

forms

Forms linked to the file. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

email_messages

Emails to link to the file. Write-only: use GET /v1/files/{id}/emails to list them. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

owner

string

Reference to the user responsible for the file, e.g. /v1/users/1000. Defaults to the user making the request.

trashed

boolean

Set to false to restore the file from the trash. Use DELETE to move it to the trash.

Responses

204

204 No Content

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

404404 Not Found