BackOffice ERPInstall

Summary

Update an existing milestone by specifying its ID along with associated project ID and new milestone details such as name, due date, and optionally description, visibility to customer, and order.

Inputs

• Milestone Id (required) — The unique identifier or a searchable keyword (name, email) to specify which milestone to update.
• Project id (required) — The ID or a searchable keyword representing the project the milestone belongs to.
• Name (required) — The new name for the milestone.
• Due date (required) — The updated due date of the milestone in date-time format.
• Description — Optional updated description for the milestone.
• Description visible to customer — Optional flag or note indicating if the description is visible to the customer.
• Milestone order — Optional order number to define the milestone's sequence.

Output shape

a single JSON object reflecting the updated milestone data as returned by the BackOffice ERP API

The operation requires valid milestone and project identifiers and will attempt to resolve names or keywords to IDs using smart search. If multiple matches are found during search, the response includes details for selection. Errors will be thrown for missing required fields or invalid identifiers. The returned object represents the updated milestone state.

Examples

Example 1: Update a milestone's name and due date by providing the milestone's numeric ID and project ID.

Set 'Milestone Id' to 123, 'Project id' to 'ACME Corp', 'Name' to 'Phase 2 Completion', 'Due date' to '2024-07-31T23:59:59Z', optionally set 'Description' and visibility fields if needed.