Book
Copies multiple books in a single batch operation with global board deduplication. Boards referenced by several books are copied only once. Boards listed in `BoardsToKeepAsSource` are not duplicated — the new book keeps a reference to the original source
When StartAfterCopy is true, portal sharing is automatically triggered
for each copied portal after the batch completes. The ShareTo field controls
the audience:
PortalMembers (default) — shares only with each portal's existing members.OrganizationMembers — shares with all members of the tenant organisation.
curl --request POST \
--url '/public-api/v1/Book/CopyMultiple' \
--header 'user-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"Books": [
{
"SourceBookId": "string",
"NewBookLabel": "string",
"BoardsToKeepAsSource": [
"string"
]
}
],
"DestinationWorkspaceId": "string",
"CopyEntities": false,
"CopyMembers": false,
"UseMemberRoleShadow": false,
"CopyApplicationRoles": false,
"StartAfterCopy": false,
"ShareTo": "PortalMembers",
"BoardRenamingStrategy": "DefaultSuffix",
"BoardRenamingSuffix": "string"
}'Autorisations
- user-api-keystringheader
User's API Key · apiKey
Corps
application/jsonBatch copy parameters.
- Booksobject[]obligatoire
- SourceBookIdstringobligatoire
- NewBookLabelstringobligatoire
- BoardsToKeepAsSourcestring[]
Boards that must NOT be duplicated for this portail. The new portail keeps a reference to the original source board. A board is only kept as source if ALL entries that reference it declare it here.
- DestinationWorkspaceIdstringobligatoire
- CopyEntitiesboolean
- CopyMembersboolean
- UseMemberRoleShadowboolean
- CopyApplicationRolesboolean
- StartAfterCopyboolean
When
true, automatically starts portal sharing for each copied portal after the batch 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.CopyMultipleBooksParameters.BoardRenamingStrategy is Statsh.Server.Api.Models.BoardRenamingStrategy.CustomSuffix. Example: "Copy Client A" → board becomes "{original label} - Copy Client A".
Réponses
Accepted
- Booksobject[]obligatoire
- SourceBookIdstringobligatoire
- NewBookIdstring
- Successboolean
- Errorstring
- CopyStatusstring
- IgnoredBoardIdsstring[]
- BoardMappingobjectobligatoire
- GraphCopyIdstring
- HasErrorsboolean