Skip to main content
POST
/
v1
/
documents
Create a document
curl --request POST \
  --url https://api.yorlet.com/v1/documents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file": "<string>",
  "name": "<string>",
  "application": "<string>",
  "customer": "<string>",
  "enquiry": "<string>",
  "owner": "<string>",
  "renewal_intent": "<string>",
  "visible": true,
  "workspace": "<string>"
}
'
{
  "id": "<string>",
  "created": 123,
  "object": "document",
  "application": "<string>",
  "customer": "<string>",
  "enquiry": "<string>",
  "file": "<string>",
  "name": "<string>",
  "owner": "<string>",
  "renewal_intent": "<string>",
  "visible": true,
  "account": "<string>",
  "deleted": false
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
​
file
string
required

The ID of the file the document references.

Minimum string length: 1
​
name
string
required

The name of the document.

Minimum string length: 1
​
application
string

The ID of the application the document is associated with.

​
customer
string

The ID of the customer the document is associated with.

​
enquiry
string

The ID of the enquiry the document is associated with.

​
owner
string

The ID of the owner the document is associated with.

​
renewal_intent
string

The ID of the renewal intent the document is associated with.

​
visible
boolean

Whether the document is visible to the associated customer.

​
workspace
string

The ID of the workspace to attach the document to.

Response

200 - application/json

Returns the document object if the request succeeded.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
document
​
application
string | null
required

The ID of the application the document is associated with.

​
customer
string | null
required

The ID of the customer the document is associated with.

​
enquiry
string | null
required

The ID of the enquiry the document is associated with.

​
file
required

The file the document references.

​
name
string | null
required

The name of the document.

​
owner
string | null
required

The ID of the owner the document is associated with.

​
renewal_intent
string | null
required

The ID of the renewal intent the document is associated with.

​
visible
boolean
required

Whether the document is visible to the associated customer.

​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.