Proposal Page - API Docs

Contents

Create

You can use this endpoint to create a content.

  • Endpoint:
POST https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns/<columnId>/contents
1
  • Response:
Status: 201

{
    "_id": "5cb869d132f905001a024656",
    "type": "empty",
    "style": {
         "backgroundImage": "",
         "backgroundRepeat": "no-repeat",
         "backgroundSize": "cover",
         "backgroundPosition": "center center",
         "opacity": 1,
     }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

  • Parameters:

    • Path:
    Name Type Description Required
    projectId string The id of the project that the content is going to be created. ✔️
    blockId string The id of the block that the content is going to be created. ✔️
    rowId string The id of the row of the column that the content is going to be created. ✔️
    columnId string The id of the column of that the content is going to be created. ✔️
    • Header:
    Name Type Description Required
    Authorization string Your Bearer Token obtained in the Auth Token endpoint. ✔️
    • Body:
    Name Type Description Required
    type string The type of the content (empty, text, image, video or quote). ✔️
    style object The style of the content.
    data object The data of the content.

  • Example:

curl -XPOST -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" -d '{ "type": "empty" }' 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657/columns/5cc0ac42003a7c001ab5c95a/contents'
1

Delete

You can use this endpoint to delete a content.

  • Endpoint:
DELETE https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns/<columnId>/contents/<contentId>
1
  • Response:
Status: 204 (no-content)
1

  • Parameters:

    • Path:
    Name Type Description Required
    projectId string The id of the project of the content that is going to be deleted. ✔️
    blockId string The id of the block of the content that is going to be deleted. ✔️
    rowId string The id of the row of the content that is going to be deleted. ✔️
    columnId string The id of the column of the content that is going to be deleted. ✔️
    contentId string The id of the content to be deleted. ✔️
    • Header:
    Name Type Description Required
    Authorization string Your Bearer Token obtained in the Auth Token endpoint. ✔️
    • Body: Empty.

  • Example:

curl -XDELETE -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657/columns/5cc0ac42003a7c001ab5c95a/contents/5cb869d132f905001a024656'
1

List

You can use this endpoint to list the contents of a column.

  • Endpoint:
GET https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns/<columnId>/contents
1
  • Response:
Status: 200

{
  [
    { ... },
    {
        "_id": "5cb869d132f905001a024656",
        "type": "empty",
        "style": {
             "backgroundImage": "",
             "backgroundRepeat": "no-repeat",
             "backgroundSize": "cover",
             "backgroundPosition": "center center",
             "opacity": 1,
         }
    },
    { ... }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

  • Parameters:

    • Path:
    Name Type Description Required
    projectId string The id of the project that the contents are going to be listed. ✔️
    blockId string The id of the block that the contents are going to be listed. ✔️
    rowId string The id of the row of the column that the contents are going to be listed. ✔️
    columnId string The id of the column that the contents are going to be listed. ✔️
    • Header:
    Name Type Description Required
    Authorization string Your Bearer Token obtained in the Auth Token endpoint. ✔️
    • Body: Empty.

  • Example:

curl -XGET -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657/columns/5cc0ac42003a7c001ab5c95a/contents'
1

Update

You can use this endpoint to update a content.

  • Endpoint:
PUT https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns/<columnId>/contents/<contentId>
1
  • Response:
Status: 200

{
    "_id": "5cb869d132f905001a024656",
    "type": "empty",
    "style": {
         "backgroundImage": "",
         "backgroundRepeat": "no-repeat",
         "backgroundSize": "cover",
         "backgroundPosition": "center center",
         "opacity": 1,
     }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

  • Parameters:

    • Path:
    Name Type Description Required
    projectId string The id of the project of the content that is going to be updated. ✔️
    blockId string The id of the block of the content that is going to be updated. ✔️
    rowId string The id of the row of the content that is going to be updated. ✔️
    columnId string The id of the column of the content that is going to be updated. ✔️
    contentId string The id of the content to be updated. ✔️
    • Header:
    Name Type Description Required
    Authorization string Your Bearer Token obtained in the Auth Token endpoint. ✔️
    • Body:
    Name Type Description Required
    type string The type of the content (empty, text, image, video or quote). ✔️
    style object The style of the content.
    data object The data of the content.

  • Example:

curl -XPUT -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" -d '{ "type": "text", "data": {} }' 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657/columns/5cc0ac42003a7c001ab5c95a/contents/5cb869d132f905001a024656'
1

Retrieve

You can use this endpoint to retrieve a content.

  • Endpoint:
GET https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns/<columnId>/contents/<contentId>
1
  • Response:
Status: 200

{
    "_id": "5cb869d132f905001a024656",
    "type": "empty",
    "style": {
         "backgroundImage": "",
         "backgroundRepeat": "no-repeat",
         "backgroundSize": "cover",
         "backgroundPosition": "center center",
         "opacity": 1,
     }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

  • Parameters:

    • Path:
    Name Type Description Required
    projectId string The id of the project of the content that is going to be retrieved. ✔️
    blockId string The id of the block of the content that is going to be retrieved. ✔️
    rowId string The id of the row of the content that is going to be retrieved. ✔️
    columnId string The id of the column of the content that is going to be retrieved. ✔️
    contentId string The id of the content to be retrieved. ✔️
    • Header:
    Name Type Description Required
    Authorization string Your Bearer Token obtained in the Auth Token endpoint. ✔️
    • Body: Empty.

  • Example:

curl -XGET -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657/columns/5cc0ac42003a7c001ab5c95a/contents/5cb869d132f905001a024656'
1
Edit this page on GitHub
Last Updated: 4/29/2019, 10:36:29 AM

← Description →