Added

Lifecycle Manager API - Expanded Workflows and Contract Migration


Summary

The Lifecycle Manager reference now covers expanded client, planning, reporting, meeting, and collaboration workflows, including quoting contacts, comment reactions, scheduled reports, and meeting policies.

This update also documents breaking changes to existing request and response contracts. The operations retain their existing v1 or v2 namespaces. Use the migration instructions below when updating integrations or regenerating clients. This reference update does not establish when a backend change was deployed.


Changes

New endpoints

The following capabilities are now included in the public reference. Follow each operation's documented permissions, feature availability, and request model.

CapabilityEndpoints and usage
Client collaboration/lifecycle-manager/v1/clients/{client_id}/contact/quoting manages a client's quoting contact. /clients/{client_id}/mention-access identifies account members who can access the client's collaboration content.
Comments and account-team roles/lifecycle-manager/v1/comments includes replies and reactions. /account-team/member/role/primary/update changes a member's primary role.
Meetings/lifecycle-manager/v1/meeting-policies includes policy configuration and compliance summaries. Meeting-series and calendar-sync operations support recurring meetings and connection settings.
Reporting and templates/lifecycle-manager/v1/scheduled-reports, /roadmap-templates, and /task-templates include configuration, recipients, delivery actions, and reusable planning content.
Client and account administrationSite, client-authorization, user-permission, client-access, role, and account-team operations are included in the reference.
Hardware and softwareHardware-type configuration, replacement policies, report availability, software exports, and lifecycle summaries are included. Use the current operation models for each asset category.
Additional planning workflowsInitiative attachments, external URLs, multiple linked tickets, Inbox operations, and Insight metadata and exports are included.

Changed

Request migrations

  • Action-item creation and updates

    • Type: breaking change
    • Endpoints: POST /lifecycle-manager/v1/action-items and PUT /lifecycle-manager/v1/action-items/{id}.
    • Migration: Use title for the action title, including inside the update payload. The legacy description title alias is no longer read or returned. The separate rich-text body uses description_json; do not move a title into that field.
  • Goal updates

    • Type: breaking change
    • Endpoint: PATCH /lifecycle-manager/v1/goals/{id}.
    • Migration: Replace plain-text description writes with a ProseMirror JSON document serialized as a string in description_json. Omit description_json to preserve content or send null to clear it. Omit title, status, target_period, and outcome_ids to preserve them; explicit null is rejected for those four fields. Send outcome_ids: [] to clear outcome assignments.
  • Client-list filters

    • Type: change
    • Endpoint: GET /lifecycle-manager/v1/clients.
    • Migration: Regenerated SDKs use arrays for filter[segment_id] and filter[client_access_group_id]. Update SDK arguments accordingly. Existing single-value HTTP queries remain supported under the same parameter names.
  • Deliverable schedules

    • Type: improvement
    • Migration: Use fire_at_utc, day_selector, and time_of_day_utc in cadence payloads and response readers. These snake_case names correct earlier reference names and match the existing wire representation.
  • Hardware custom fields and goal templates

    • Type: improvement
    • Endpoints: POST /lifecycle-manager/v1/assets/hardware/custom-fields, PUT /lifecycle-manager/v1/assets/hardware/custom-fields/{hardware_custom_field_id}, and POST /lifecycle-manager/v1/goals/create-from/template/{goal_template_id}.
    • Notes: Custom-field requests describe their Text, Date, and Select variants explicitly. Select options can be omitted or null; on update, either clears the active options. Goal-template create_linked_initiatives is optional and defaults to false; explicit null is rejected.
  • Agreement creation

    • Type: change
    • Endpoint: POST /lifecycle-manager/v1/agreements.
    • Notes: The request no longer documents skip_initial_item. Use the current agreement-creation request when regenerating clients.

Response migrations

EndpointTypeMigration
GET /lifecycle-manager/v1/budget/{client_id}/contracts, /initiatives, and /it-debtBreaking changeRead rows.data, rows.next_cursor, and rows.total_count in place of root pagination fields. column_keys and currency_code remain at the root.
GET /lifecycle-manager/v1/assets/hardware/metadataBreaking changeIterate filters.data in place of the former filters array. Retrieve report availability from GET /lifecycle-manager/v1/assets/hardware/lifecycle-report/availability; metadata no longer includes hardware_lifecycle_report_availability.
POST /lifecycle-manager/v1/assets/hardware/sourcesBreaking changeIterate sources.data in place of the former sources array.
GET /lifecycle-manager/v1/initiatives/{initiative_id}/assetsBreaking changeRead linked hardware from data instead of hardware_keys.
GET /lifecycle-manager/v1/meetings/{meeting_id}/deliverablesBreaking changeRead linked deliverables from data instead of deliverable_ids.
PUT /lifecycle-manager/v2/meetings/{id}Breaking changeAccept 200 OK with the documented JSON body instead of requiring an empty 204 No Content response. anchor_meeting_deleted reports whether the meeting used to open the series was removed.
GET /lifecycle-manager/v1/clients/{client_id}Breaking changeStop reading customer_since. No equivalent relationship-start date is provided; the former value reflected organization creation/recreation time.
GET /lifecycle-manager/v1/account/logoReference correctionTreat the response as the documented image bytes, rather than JSON or plain text.

Ticket URLs, vendor integration identifiers, contact source-record identifiers, and unanswered assessment criteria are documented as optional or nullable where the service already permits that state. Handle those values when regenerating clients. Opportunity input variants still include their required type; use the declared variant models to access their additional fields.

Route migrations

These earlier routes are no longer included as supported operations. Review the replacement models as well as the URL; request and response shapes can differ.

Previous operationReplacement
GET /lifecycle-manager/v1/assets/hardware/report-asset-typesHardware types under /lifecycle-manager/v1/assets/types.
GET /lifecycle-manager/v1/assets/hardware/report-asset-type-settingsHardware-type and replacement resources under /lifecycle-manager/v1/assets/types.
PUT /lifecycle-manager/v1/assets/hardware/report-asset-typePUT /lifecycle-manager/v1/assets/hardware/type.
GET /lifecycle-manager/v1/assets/hardware-replacement/settingsGET /lifecycle-manager/v1/assets/hardware/replacement-cost.
GET /lifecycle-manager/v1/clients/{client_id}/members/lookupGET /lifecycle-manager/v1/members/lookup with the documented search query. This searches account-level PSA members and is no longer scoped by a client route parameter.

Documentation restored

  • GET /lifecycle-manager/v1/assets/contacts/export documents both XLSX and CSV downloads. Use format=Csv for text/csv; XLSX remains the default.
  • GET /lifecycle-manager/v1/insights/{insight_id}/assets includes filter[hasscalepadwarranty], filter[initiativecount], and filter[site.id]. The first two are conditional boolean filters requiring access to full hardware console columns; initiativecount means whether hardware belongs to an initiative. Site filtering requires client scope. Consult the available filter metadata for the requested scope.

Deprecated

  • GET, POST, and DELETE /lifecycle-manager/v1/initiatives/{initiative_id}/ticket
    • Type: deprecation
    • Notes: These compatibility operations remain supported and are documented as deprecated. The singular GET returns the first linked ticket state, POST preserves the single-link constraint, and DELETE detaches the legacy link. New integrations should use /initiatives/{initiative_id}/tickets and /tickets/{ticket_link_id}. No retirement date is announced.

Dates

  • Reference updated: 2026-10-22