Pages

Change one screenshot, or several: words, screen, style or design

What editing a screenshot on the Pages screen changes. Send one change as the body itself, or several screenshots of the page under changes (ten at most, each screenshot once, made in order). screen is the position of one of the app's screens (GET /v1/apps/{id}/screens), and each screen appears once on a page. Each screenshot is drawn again and checked again, and the page's approval is withdrawn. The answer says, in changes, what each screenshot took and what it did not, with the reason: a headline cannot be set on a screenshot that still shows the developer's own words (own_words), and a style has nothing to change on a design that is theirs (design). What a screenshot does not take is not kept. When nothing in the call took, the answer is 422 with code words_kept, kept_whole or style_not_ours, and the page is as it was. "return": "changed" answers with only the screenshots that changed. A change by hand is never counted against a plan.

patch/pages/{id}

Request

  • Base URL: https://pagefully.com/api/v1
  • URL: https://pagefully.com/api/v1/pages/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The page's id.

Request body

slot_idstring uuid

The screenshot, by id.

positioninteger

The screenshot, by its place on the page.

headlinestring
sublinestring
screeninteger

The position of the app screen to show.

style'clean' | 'bold' | 'soft' | 'night' | 'lift' | 'closeup' nullable

Its own style, or null for the page's. Applies to a screenshot in Pagefully's own design.

highlightstring

The words of the headline to mark, on a design that marks some.

design'ours' | 'theirs'

ours: draw this screen in Pagefully's own design, where a headline and a style both apply. theirs: keep the developer's own design and change only its words. Kept for that screen on every page of the app.

return'page' | 'changed'

page: the whole page, which is what is returned when this is left out. changed: only the screenshots this call changed.

Response

What changed, and the page after it (or, with "return": "changed", only the screenshots that changed, marked partial).

Changes

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