Agreements Attach Agreement File
Header Parameters
Optional correlation ID.
Unique idempotency key (UUID v4).
Path Parameters
The agreement to attach the file to.
Body Parameters
The file to upload.
Response
File uploaded and attached successfully.
Response Attributes
Primary key of the created record.
The agreement this file belongs to.
The Document Index external object ID.
File size in bytes.
Whether the record is active.
No file provided or file is empty.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Bearer token is missing or invalid.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Caller token does not resolve to a known customer shard.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Agreement not found.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Document Index upload failed.
Unexpected error
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.