Get upload URL for note attachment

POST /api/v1/notes/{note_id}/attachments/upload-url

Generate a presigned URL to upload a file to S3 for a note.

Operation ID: get_attachment_upload_url_api_v1_notes__note_id__attachments_upload_url_post · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

note_id string required

Request body

Schema: NoteAttachmentUploadUrlRequest

file_name string required
mime_type string required
file_size integer required

Responses

201 Successful Response

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

POST /api/v1/notes/{note_id}/attachments/upload-url

bash

curl -X POST 'https://api.ondayzero.com/api/v1/notes/{note_id}/attachments/upload-url' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "file_name": "string",
  "mime_type": "string",
  "file_size": 0
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/notes/{note_id}/attachments/upload-url', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "file_name": "string",
  "mime_type": "string",
  "file_size": 0
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "file_name": "string",
  "mime_type": "string",
  "file_size": 0
}

response = httpx.post("https://api.ondayzero.com/api/v1/notes/{note_id}/attachments/upload-url", headers=headers, json=payload)
data = response.json()