{
"customer_external_id": "string",
"display_name": "string",
"external": {
"file_size": "integer",
"file_url": "string"
},
"file_name": "string",
"internal": {
"FileData": [
"integer"
],
"file_data": "string"
},
"origin": {
"type": {},
"value": "string"
},
"tag_codes": [
"string"
]
}
const response = await fetch(
"POST /api/v1/customer_documents/upload",
{
method: "post",
headers: {
"Content-Type": "application/json",
"Authorization": `Bearer {token}`
},
body: JSON.stringify({
"customer_external_id": "string",
"display_name": "string",
"external": {
"file_size": "integer",
"file_url": "string"
},
"file_name": "string",
"internal": {
"FileData": [
"integer"
],
"file_data": "string"
},
"origin": {
"type": {},
"value": "string"
},
"tag_codes": [
"string"
]
})
}
);
{
"created_at": "integer",
"customer_external_id": "string",
"display_name": "string",
"file_mime": "string",
"file_name": "string",
"file_size": "integer",
"file_source": "string",
"file_type": "string",
"file_url": "string",
"id": "string",
"last_revision_agent_id": "integer",
"last_revision_created_at": "integer",
"last_revision_id": "string",
"origin": {
"type": {},
"value": "string"
},
"tags": [
"string"
]
}
{
"errors": [
{
"code": "string",
"deprecated": "boolean",
"message": "string",
"will_be_deprecated": "boolean"
}
]
}
Customer Document
Upload document
Uploads a document.
POST
/
api
/
v1
/
customer_documents
/
upload
{
"customer_external_id": "string",
"display_name": "string",
"external": {
"file_size": "integer",
"file_url": "string"
},
"file_name": "string",
"internal": {
"FileData": [
"integer"
],
"file_data": "string"
},
"origin": {
"type": {},
"value": "string"
},
"tag_codes": [
"string"
]
}
const response = await fetch(
"POST /api/v1/customer_documents/upload",
{
method: "post",
headers: {
"Content-Type": "application/json",
"Authorization": `Bearer {token}`
},
body: JSON.stringify({
"customer_external_id": "string",
"display_name": "string",
"external": {
"file_size": "integer",
"file_url": "string"
},
"file_name": "string",
"internal": {
"FileData": [
"integer"
],
"file_data": "string"
},
"origin": {
"type": {},
"value": "string"
},
"tag_codes": [
"string"
]
})
}
);
{
"created_at": "integer",
"customer_external_id": "string",
"display_name": "string",
"file_mime": "string",
"file_name": "string",
"file_size": "integer",
"file_source": "string",
"file_type": "string",
"file_url": "string",
"id": "string",
"last_revision_agent_id": "integer",
"last_revision_created_at": "integer",
"last_revision_id": "string",
"origin": {
"type": {},
"value": "string"
},
"tags": [
"string"
]
}
{
"errors": [
{
"code": "string",
"deprecated": "boolean",
"message": "string",
"will_be_deprecated": "boolean"
}
]
}
Body parameters
string
string
string
string[]
Response body
- 200
- default
integer
string
string
string
string
integer
string
string
string
string
integer
integer
string
string[]
{
"customer_external_id": "string",
"display_name": "string",
"external": {
"file_size": "integer",
"file_url": "string"
},
"file_name": "string",
"internal": {
"FileData": [
"integer"
],
"file_data": "string"
},
"origin": {
"type": {},
"value": "string"
},
"tag_codes": [
"string"
]
}
const response = await fetch(
"POST /api/v1/customer_documents/upload",
{
method: "post",
headers: {
"Content-Type": "application/json",
"Authorization": `Bearer {token}`
},
body: JSON.stringify({
"customer_external_id": "string",
"display_name": "string",
"external": {
"file_size": "integer",
"file_url": "string"
},
"file_name": "string",
"internal": {
"FileData": [
"integer"
],
"file_data": "string"
},
"origin": {
"type": {},
"value": "string"
},
"tag_codes": [
"string"
]
})
}
);
{
"created_at": "integer",
"customer_external_id": "string",
"display_name": "string",
"file_mime": "string",
"file_name": "string",
"file_size": "integer",
"file_source": "string",
"file_type": "string",
"file_url": "string",
"id": "string",
"last_revision_agent_id": "integer",
"last_revision_created_at": "integer",
"last_revision_id": "string",
"origin": {
"type": {},
"value": "string"
},
"tags": [
"string"
]
}
{
"errors": [
{
"code": "string",
"deprecated": "boolean",
"message": "string",
"will_be_deprecated": "boolean"
}
]
}
⌘I