> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Update CoworkerDelivery
> Update an existing CoworkerDelivery record.
Updates an existing CoworkerDelivery record. You must include the `Id` of the record to update along with all required fields.
## Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
The authenticated user must be a full unrestricted administrator or have the **`CoworkerDelivery-Edit`** role.
## Enums
| Value | Name |
| ----- | --------- |
| 0 | None |
| 1 | Mail |
| 2 | Parcel |
| 3 | Check |
| 4 | Publicity |
| 5 | Other |
| Value | Name |
| ----- | -------------------------- |
| 0 | None |
| 1 | StoreForCollection |
| 2 | Forward |
| 3 | OpenScanForward |
| 4 | OpenScanRecycle |
| 5 | OpenScanShred |
| 6 | OpenScanStoreForCollection |
| 7 | Recycle |
| 8 | ReturnToSender |
| 9 | Shred |
| 10 | DepositCheck |
| 11 | Unknown |
## Request Body
### Required Fields
The Id of the CoworkerDelivery record to update.
Business Id.
Short label or description identifying the delivery item.
Physical location where the delivery is being stored (e.g. mailroom shelf).
Type of delivery item (Mail, Parcel, Check, Publicity, or Other).
### Optional Fields
Coworker Id.
Contract Contact Id.
Name of the staff member who received the delivery.
Free-text notes about the delivery.
New File Data Url.
Clear File Data File.
New Signature Url.
Clear Signature File.
New Scanned File Data Url.
Clear Scanned File Data File.
New Forwarded File Data Url.
Clear Forwarded File Data File.
Whether the customer has collected the delivery.
Whether the customer must sign upon collection.
Whether the customer has signed for the delivery.
Notified.
Date and time the customer collected the delivery.
Billed.
How the customer wants this delivery handled (e.g. StoreForCollection, Forward, Shred). See `eDeliveryHandlingPreference?` enum above.
Whether the enclosed check has been deposited.
Whether the delivery has been forwarded to the customer.
Whether the delivery contents have been scanned.
Whether the delivery has been recycled.
Whether the delivery has been shredded.
Whether the delivery is being held for customer collection.
Whether the delivery has been returned to sender.
Date and time the check was deposited.
Date and time the delivery was forwarded.
Date and time the delivery contents were scanned.
Date and time the delivery was recycled.
Date and time the delivery was shredded.
Date and time the delivery was placed in storage for collection.
Date and time the delivery was returned to sender.
Forwarding Address Unique Id.
Check Deposited Product Unique Id.
Forwarded Product Unique Id.
Scanned Product Unique Id.
Recycled Product Unique Id.
Shredded Product Unique Id.
Stored For Collection Product Unique Id.
Returned To Sender Product Unique Id.
Collected Product Unique Id.
## Code Examples
```bash cURL theme={null}
curl -X PUT \
"https://spaces.nexudus.com/api/spaces/coworkerdeliveries" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"BusinessId": 0,
"Name": "",
"Location": "",
"DeliveryType": 0,
"Id": 87654321
}'
```
```javascript JavaScript theme={null}
const response = await fetch(
'https://spaces.nexudus.com/api/spaces/coworkerdeliveries',
{
method: 'PUT',
headers: {
'Authorization': 'Bearer YOUR_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({
BusinessId: 0,
Name: '',
Location: '',
DeliveryType: 0,
Id: 87654321
})
}
);
const data = await response.json();
```
```python Python theme={null}
import requests
response = requests.put(
'https://spaces.nexudus.com/api/spaces/coworkerdeliveries',
headers={
'Authorization': 'Bearer YOUR_TOKEN',
'Content-Type': 'application/json'
},
json={
'BusinessId': 0,
'Name': '',
'Location': '',
'DeliveryType': 0,
'Id': 87654321
}
)
data = response.json()
```
## Response
### 200
HTTP status code. `200` on success.
A human-readable message confirming the update.
Contains the `Id` of the updated record.
`true` if the coworkerdelivery was updated successfully.
`null` on success.
```json Example Response theme={null}
{
"Status": 200,
"Message": "CoworkerDelivery was successfully updated.",
"Value": {
"Id": 87654321
},
"OpenInDialog": false,
"OpenInWindow": false,
"RedirectURL": null,
"JavaScript": null,
"UpdatedOn": "2025-01-15T10:30:00Z",
"UpdatedBy": "admin@example.com",
"Errors": null,
"WasSuccessful": true
}
```
### 400
A summary of the validation error(s), in the format `PropertyName: error message`.
`null` on validation failure.
Array of validation errors.
The value that was submitted for the field, or `null` if missing.
The validation error message.
The name of the property that failed validation.
`false` when the request fails validation.
```json Example Response theme={null}
{
"Message": "Name: is a required field",
"Value": null,
"Errors": [
{
"AttemptedValue": null,
"Message": "is a required field",
"PropertyName": "Name"
}
],
"WasSuccessful": false
}
```