Skip to content
PassionPassion developers

Replace the Home page of the App

PUT
/apps/{appId}/home
curl --request PUT \
  --url https://api.passion.io/v1/apps/example/home \
  --header 'Content-Type: application/json' \
  --data '{ "tagline": "example", "cover": { "kind": "image", "fileId": "example" }, "story": [ { "heading": "example", "text": "example", "picture": { "kind": "image", "fileId": "example" } } ], "highlights": [ "example" ], "testimonials": [ { "quote": "example", "name": "example", "photoFileId": "example" } ], "questions": [ { "question": "example", "answer": "example" } ], "sections": [ { "kind": "story", "hidden": true } ], "offerIds": [ "example" ], "frontDoor": "open", "membersOnlyLine": "example" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
appId
required

The id of the App, as Studio shows it.

string
/^[1-9][0-9]*$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
tagline
required
Any of:
string
>= 1 characters <= 80 characters
cover
required
Any of:
object
kind
required
string
Allowed values: image video
fileId
required

The id of a file that create_upload answered, after the file is uploaded.

string
/^[1-9][0-9]*$/
story
required

Up to three blocks about the creator.

Array<object>
<= 3 items
object
heading
required
string
<= 120 characters
text
required
string
<= 400 characters
picture
required
Any of:
object
kind
required
string
Allowed values: image video
fileId
required

The id of a file that create_upload answered, after the file is uploaded.

string
/^[1-9][0-9]*$/
highlights
required

Short lines about what members get. Empty lets the App say them.

Array<string>
<= 5 items
testimonials
required
Array<object>
<= 10 items
object
quote
required
string
>= 1 characters <= 400 characters
name
required
string
>= 1 characters <= 120 characters
photoFileId
required
Any of:

The id of a file that create_upload answered, after the file is uploaded.

string
/^[1-9][0-9]*$/
questions
required

Questions a visitor asks, each with its answer.

Array<object>
<= 6 items
object
question
required
string
>= 1 characters <= 200 characters
answer
required
string
>= 1 characters <= 600 characters
sections
required

Every section kind once, in the order a visitor sees them. A hidden section is not shown.

Array<object>
object
kind
required
string
Allowed values: story highlights testimonials community assistant questions
hidden
required
boolean
offerIds
required
Any of:
Array<string>
<= 8 items
frontDoor
required

open: visitors see the Home. members_only: visitors see only the tagline, the members-only line and a sign-in.

string
Allowed values: open members_only
membersOnlyLine
required
Any of:
string
>= 1 characters <= 160 characters

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
tagline
required
Any of:
string
cover
required
Any of:
object
kind
required
string
Allowed values: image video
fileId
required
Any of:
string
url
required

The current address of the picture.

string
story
required
Array<object>
object
heading
required
string
text
required
string
picture
required
Any of:
object
kind
required
string
Allowed values: image video
fileId
required
Any of:
string
url
required

The current address of the picture.

string
highlights
required
Array<string>
testimonials
required
Array<object>
object
quote
required
string
name
required
string
photoFileId
required
Any of:
string
photoUrl
required
Any of:
string
questions
required
Array<object>
object
question
required
string
answer
required
string
sections
required

Every section kind once, in the order a visitor sees them. A hidden section is not shown.

Array<object>
object
kind
required
string
Allowed values: story highlights testimonials community assistant questions
hidden
required
boolean
offerIds
required
Any of:
Array<string>
frontDoor
required

open: visitors see the Home. members_only: visitors see only the tagline, the members-only line and a sign-in.

string
Allowed values: open members_only
membersOnlyLine
required
Any of:
string
updatedAt
required
Any of:
string
Example
{
  "cover": {
    "kind": "image"
  },
  "story": [
    {
      "picture": {
        "kind": "image"
      }
    }
  ],
  "sections": [
    {
      "kind": "story"
    }
  ],
  "frontDoor": "open"
}