Daylite WebsiteMarketcircle Blog
API Reference

File

post
https://api.marketcircle.net/v1/files

Create a file record

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Creates a file record. This doesn't upload the content; do that next with File Content. See Adding a file.

{
  "name": "proposal.pdf",
  "extension": "pdf",
  "title": "Proposal",
  "contacts": [{ "contact": "/v1/contacts/1000" }]
}

A successful request returns 201 Created with the new file's reference, e.g. {"location": "/v1/files/5000"}.

Body Params
string

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

string

Title shown in Daylite.

string

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

string

Description of the file.

appointments
array of objects

Appointments linked to the file. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

appointments
contacts
array of objects

Contacts linked to the file. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

contacts
companies
array of objects

Companies linked to the file. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

companies
opportunities
array of objects

Opportunities linked to the file. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

opportunities
projects
array of objects

Projects linked to the file. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

projects
tasks
array of objects

Tasks linked to the file. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

tasks
groups
array of objects

Groups linked to the file. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

groups
notes
array of objects

Notes linked to the file. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

notes
forms
array of objects

Forms linked to the file. On update, an array replaces the whole list. Send {"add": [...], "remove": [...]} instead to change only some entries.

forms
email_messages
array of objects

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

email_messages
string

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

Responses

Updated 9 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 days ago