Book
Copy a book with all its referenced boards to a destination workspace
This endpoint copies the entire book including:
- All sections and section elements (pages, views, board sections)
- All boards referenced in the book's section elements
- All inter-board relations between the copied boards
- Permission matrices (application roles) from the source book
The copy operation preserves the navigation structure - all view references in the new book will point to the newly copied boards.
When StartAfterCopy is true, portal sharing is automatically triggered
after the copy completes. The ShareTo field controls the audience:
PortalMembers (default) — shares only with the portal's existing members.OrganizationMembers — shares with all members of the tenant organisation.
Requirements:
- User must have at least Visitor role on the source book
- User must have Contributor role on the destination workspace
- User must have copy permission on all referenced boards
curl --request POST \
--url '/public-api/v1/Book/{bookId}/Copy' \
--header 'user-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"DestinationWorkspaceId": "string",
"BookLabel": "string",
"CopyEntities": false,
"CopyBoards": false,
"CopyMembers": false,
"UseMemberRoleShadow": false,
"CopyApplicationRoles": false,
"StartAfterCopy": false,
"ShareTo": "PortalMembers",
"BoardRenamingStrategy": "DefaultSuffix",
"BoardRenamingSuffix": "string"
}'Autorisations
- user-api-keystringheader
User's API Key · apiKey
Paramètres de chemin
- bookIdstringobligatoire
Corps
application/jsonCopy parameters including destination workspace and new label
- DestinationWorkspaceIdstring
Destination workspace's id
- BookLabelstringobligatoire
Created book label
- CopyEntitiesboolean
Whether to copy entities in the referenced boards
- CopyBoardsboolean
Whether to duplicate linked boards or keep references to existing ones
- CopyMembersboolean
- UseMemberRoleShadowboolean
true:: add duplicated members with Shadow role (no invitation sent) / false:: add duplicated members with their original roles (invitations sent)
- CopyApplicationRolesboolean
- StartAfterCopyboolean
When
true, automatically starts portal sharing after the copy completes. - ShareTostring
Defines who the duplicated books are shared with when
StartAfterCopyistrue. - BoardRenamingStrategystring
Defines how copied boards are renamed during a book duplication.
- BoardRenamingSuffixstring
Custom suffix appended to each copied board label when Statsh.Server.Api.Models.CopyBookWithBoardsParameters.BoardRenamingStrategy is Statsh.Server.Api.Models.BoardRenamingStrategy.CustomSuffix. Example: "Nom du client" → board becomes "{original label} - Nom du client".
Réponses
OK