projects

patch/projects/{projectId}

Request

  • Base URL: https://api.sweep.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.sweep.io/projects/{projectId}
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Request body

namestring
descriptionstring
visibility'team' | 'private'
autonomyMode'guided' | 'balanced' | 'autonomous' nullable
orgType'salesforce' | 'snowflake' | 'data360' | 'servicenow' | 'hubspot' | 'workato'
migrationTypeNamestring nullable
migrationStepNamestring nullable

Response

idstring required
namestring required
descriptionstring nullable required
visibility'team' | 'private' required
accountIdstring required
createdByIdstring required
autonomyMode'guided' | 'balanced' | 'autonomous' nullable required
orgType'salesforce' | 'snowflake' | 'data360' | 'servicenow' | 'hubspot' | 'workato' required
migrationTypeNamestring nullable required

Denormalized labels from the playbook template manager's migration catalog. Free text — the catalog itself is not modelled here.

migrationStepNamestring nullable required
originTemplateId'blank' | 'cpq-agentforce-revenue-management' | 'process-builder-to-flow' | 'profiles-permission-set-groups-migration' | 'visualforce-aura-lwc-modernization' | 'field-cleanup-hygiene' | 'salesforce-winter-27-release-prep' | 'ai-security-risk-remediation' | 'product-catalog-rationalization' | 'agentforce-readiness' | 'cim' | 'case-management' | 'channels' | 'routing' | 'workspace' | 'portal' | 'email-notifications' | 'csm-org-assessment' | 'cpq-1-product-catalog' | 'sfa-1-cim-for-sales' | 'sfa-2-lead-and-opportunity' | 'sfa-3-sales-workspace' | 'sfa-4-activities' | 'sfa-5-forecasting' | 'sfa-6-custom-processes' | 'sfa-org-assessment' nullable

API-facing origin template id. Not a DB column — populated from originTemplate.originTemplateExternalId when that relation is loaded.

createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.