photobook_series_apply
Changes series in the Photobook app (pApp B00005). Another app code is refused before any request. Called without confirmToken it previews and returns a confirmToken; repeating the same input with it executes once.
Inputs
| Field | Required here | Contract |
|---|---|---|
action |
Yes | one of: create, update, appearance, visibility, delete, link, unlink, move, series_selection, resource_controls (by kind) |
action.title |
Yes | When action.kind is create: string; min length 1; max length 150 |
action.isPublished |
Yes | When action.kind is create: boolean |
action.explicitNavigationType |
No | When action.kind is create: NAV_B00005_HORIZONTAL_POST_VIEWING, NAV_B00005_VERTICAL_POST_VIEWING |
action.seriesId |
Yes | When action.kind is update: integer; greater than 0 |
action.fields |
No | When action.kind is update: object or object |
action.fields.title |
No | When action.kind is update and action.fields is alternative 1: string; min length 1; max length 150 |
action.fields.description |
No | When action.kind is update and action.fields is alternative 1: string; min length 0; max length 800 or null; Omit to preserve; null or an empty string clears the source description to null. |
action.fields.thumbnailSrc |
No | When action.kind is update and action.fields is alternative 1: string; max length 4096; format uri or `` |
action.fields.coverImageSrc |
No | When action.kind is update and action.fields is alternative 1: string; max length 4096; format uri or `` |
action.fields.logoImageSrc |
No | When action.kind is update and action.fields is alternative 1: string; max length 4096; format uri or `` |
action.fields.publishedAt |
No | When action.kind is update and action.fields is alternative 1: string; pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:Z)|(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d)$ |
action.fields.explicitNavigationType |
No | When action.kind is update and action.fields is alternative 1: NAV_B00005_HORIZONTAL_POST_VIEWING, NAV_B00005_VERTICAL_POST_VIEWING |
action.fields.useWatermarkOverlayProtection |
No | When action.kind is update and action.fields is alternative 1: boolean |
action.articleImageUploads |
No | When action.kind is update: object |
action.articleImageUploads.thumbnailTaskId |
No | When action.kind is update: string; pattern ^[A-Za-z0-9_-]{8,80}$ |
action.articleImageUploads.coverTaskId |
No | When action.kind is update: string; pattern ^[A-Za-z0-9_-]{8,80}$ |
action.seriesId |
Yes | When action.kind is appearance: integer; greater than 0 |
action.settings |
Yes | When action.kind is appearance: object or object |
action.settings.enabled |
No | When action.kind is appearance and action.settings is alternative 1: boolean |
action.settings.postListTemplate |
No | When action.kind is appearance and action.settings is alternative 1: LIST_A, LIST_B, LIST_C, CARD_GRID, FOCUS_IMAGE |
action.settings.postListDesign |
Yes | When action.kind is appearance and action.settings is alternative 2: HORIZONTAL_SCROLL_IMPACT, VERTICAL_SCROLL_GRID, VERTICAL_SCROLL_LIST_A, VERTICAL_SCROLL_LIST_B |
action.seriesId |
Yes | When action.kind is visibility: integer; greater than 0 |
action.isPublished |
Yes | When action.kind is visibility: boolean |
action.seriesId |
Yes | When action.kind is delete: integer; greater than 0 |
action.confirmation |
Yes | When action.kind is delete: DELETE_SERIES |
action.seriesId |
Yes | When action.kind is link: integer; greater than 0 |
action.postIds |
Yes | When action.kind is link: array; items: integer; greater than 0; min items 1; max items 100 |
action.seriesId |
Yes | When action.kind is unlink: integer; greater than 0 |
action.episodeId |
Yes | When action.kind is unlink: integer; greater than 0 |
action.seriesId |
Yes | When action.kind is move: integer; greater than 0 |
action.episodeId |
Yes | When action.kind is move: integer; greater than 0 |
action.beforeEpisodeId |
Yes | When action.kind is move: integer; greater than 0 or null; Move this episode before the selected episode; null moves it to the end. |
action.operation |
Yes | When action.kind is series_selection: publish, unpublish, delete |
action.seriesIds |
Yes | When action.kind is series_selection: array; items: integer; greater than 0; min items 1; max items 100 |
action.confirmation |
Yes | When action.kind is series_selection: PUBLISH_SELECTED_SERIES, UNPUBLISH_SELECTED_SERIES, DELETE_SELECTED_SERIES |
action.seriesId |
Yes | When action.kind is resource_controls: integer; greater than 0 |
action.imageDownloadable |
Yes | When action.kind is resource_controls: boolean |
action.confirmation |
No | When action.kind is resource_controls: ALLOW_IMAGE_DOWNLOAD |
confirmToken |
No | string; pattern ^ct[a-f\d]{32}$; The confirmToken from this tool's preview result. Omit it to preview; repeat the same input with it to execute. |