Skip to content

docs: clarify salesforce_dashboard_clone does not accept a name parameter — document clone-then-rename pattern #599

@saif-at-scalekit

Description

@saif-at-scalekit

Summary

A customer (Pylon #667) requested adding a name parameter to salesforce_dashboard_clone. Investigation revealed the Salesforce Analytics REST API does not support a name field in the clone payload — this is a common source of confusion because the Salesforce Report clone API (POST /analytics/reports?cloneId={id}) does accept a name via reportMetadata. Both APIs sit under /analytics/ and follow a similar pattern, making the difference easy to miss.

Resolution given in support

Use salesforce_dashboard_update as a second step after cloning to rename the dashboard:

{
  "dashboard_id": "<cloned_dashboard_id>",
  "name": "New Dashboard Name"
}

Documentation gap

The salesforce_dashboard_clone tool reference should include:

  1. An explicit note that the name parameter is not supported in the clone payload (contrast with Report clone API)
  2. A usage tip showing the two-step clone-then-rename pattern using salesforce_dashboard_update
  3. A brief note clarifying the difference between Dashboard clone and Report clone behavior

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions