Skip to main content
PUT
/
api
/
spaces
/
coworkerdeliveries
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
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

ValueName
0None
1Mail
2Parcel
3Check
4Publicity
5Other
ValueName
0None
1StoreForCollection
2Forward
3OpenScanForward
4OpenScanRecycle
5OpenScanShred
6OpenScanStoreForCollection
7Recycle
8ReturnToSender
9Shred
10DepositCheck
11Unknown

​
Request Body

​
Required Fields

​
Id
integer
required
The Id of the CoworkerDelivery record to update.
​
BusinessId
integer
required
Business Id.
​
Name
string
required
Short label or description identifying the delivery item.
​
Location
string
required
Physical location where the delivery is being stored (e.g. mailroom shelf).

​
Optional Fields

​
CoworkerId
integer
Coworker Id.
​
ContractContactId
integer
Contract Contact Id.
​
ReceivedBy
string
Name of the staff member who received the delivery.
​
Notes
string
Free-text notes about the delivery.
​
NewFileDataUrl
string
New File Data Url.
​
ClearFileDataFile
boolean
Clear File Data File.
​
NewSignatureUrl
string
New Signature Url.
​
ClearSignatureFile
boolean
Clear Signature File.
​
NewScannedFileDataUrl
string
New Scanned File Data Url.
​
ClearScannedFileDataFile
boolean
Clear Scanned File Data File.
​
NewForwardedFileDataUrl
string
New Forwarded File Data Url.
​
ClearForwardedFileDataFile
boolean
Clear Forwarded File Data File.
​
Collected
boolean
Whether the customer has collected the delivery.
​
RequiresSignature
boolean
Whether the customer must sign upon collection.
​
Signed
boolean
Whether the customer has signed for the delivery.
​
Notified
boolean
Notified.
​
CollectedOn
string
Date and time the customer collected the delivery.
​
Billed
boolean
Billed.
​
DeliveryType
integer
Type of delivery item (Mail, Parcel, Check, Publicity, or Other). See eDeliveryType enum above.
​
HandlingPreference
integer
How the customer wants this delivery handled (e.g. StoreForCollection, Forward, Shred). See eDeliveryHandlingPreference? enum above.
​
CheckDeposited
boolean
Whether the enclosed check has been deposited.
​
Forwarded
boolean
Whether the delivery has been forwarded to the customer.
​
Scanned
boolean
Whether the delivery contents have been scanned.
​
Recycled
boolean
Whether the delivery has been recycled.
​
Shredded
boolean
Whether the delivery has been shredded.
​
StoredForCollection
boolean
Whether the delivery is being held for customer collection.
​
ReturnedToSender
boolean
Whether the delivery has been returned to sender.
​
CheckDepositedOn
string
Date and time the check was deposited.
​
ForwardedOn
string
Date and time the delivery was forwarded.
​
ScannedOn
string
Date and time the delivery contents were scanned.
​
RecycledOn
string
Date and time the delivery was recycled.
​
ShreddedOn
string
Date and time the delivery was shredded.
​
StoredForCollectionOn
string
Date and time the delivery was placed in storage for collection.
​
ReturnedToSenderOn
string
Date and time the delivery was returned to sender.
​
ForwardingAddressUniqueId
string
Forwarding Address Unique Id.
​
CheckDepositedProductUniqueId
string
Check Deposited Product Unique Id.
​
ForwardedProductUniqueId
string
Forwarded Product Unique Id.
​
ScannedProductUniqueId
string
Scanned Product Unique Id.
​
RecycledProductUniqueId
string
Recycled Product Unique Id.
​
ShreddedProductUniqueId
string
Shredded Product Unique Id.
​
StoredForCollectionProductUniqueId
string
Stored For Collection Product Unique Id.
​
ReturnedToSenderProductUniqueId
string
Returned To Sender Product Unique Id.
​
CollectedProductUniqueId
string
Collected Product Unique Id.

​
Code Examples

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": "",
    "Id": 87654321
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the update.
​
Value
object
Contains the Id of the updated record.
​
WasSuccessful
boolean
true if the coworkerdelivery was updated successfully.
​
Errors
array
null on success.
Example Response
{
  "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

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}