Proposal Page - API Docs

Rows

Clone

You can use this endpoint to clone a row and put it in a specific position.

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

{
  "_id": "5cb869d232f905001a024657",
  "description": "New row",
  "columns": [ columnSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9

  • Parameters:

    • Path:
    Name Type Description Required
    projectId string The id of the project of the row that is going to be cloned. ✔️
    blockId string The id of the block of the row that is going to be cloned. ✔️
    rowId string The id of the row that is going to be cloned. ✔️
    position number The position to put the row that is going to be cloned (eg. 0 is first).
    • Header:
    Name Type Description Required
    Authorization string Your Bearer Token obtained in the Auth Token endpoint. ✔️
    • Body: Empty.

  • Example:

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

Create

You can use this endpoint to create a row.

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

{
  "_id": "5cb869d232f905001a024657",
  "description": "New row",
  "columns": [ columnSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9

  • Parameters:

    • Path:
    Name Type Description Required
    projectId string The id of the project of the row that is going to be created. ✔️
    blockId string The id of the block of the row that 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
    description string Row description. ✔️
    columns array Row columns.

  • Example:

curl -XPOST -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" -d '{ "description": "New row", "columns": [] }' 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows'
1

Delete

You can use this endpoint to delete a row.

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

  • Parameters:

    • Path:
    Name Type Description Required
    projectId string The id of the project of the row that is going to be deleted. ✔️
    blockId string The id of the block of the row that is going to be deleted. ✔️
    rowId string The id of the row that is going 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'
1

List

You can use this endpoint to list the rows of a block.

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

{
  [
    { ... },
    {
      "_id": "5cb869d232f905001a024657",
      "description": "New row",
      "columns": [ columnSchema ],
      "createdAt": "2019-01-18T13:56:53.742Z",
      "updatedAt": "2019-01-18T13:56:53.742Z"
    },
    { ... }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

  • Parameters:

    • Path:
    Name Type Description Required
    projectId string The id of the project that the block rows are going to be listed. ✔️
    blockId string The id of the block that the rows 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'
1

Update

You can use this endpoint to update a row.

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

{
  "_id": "5cb869d232f905001a024657",
  "description": "New row",
  "columns": [ columnSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9

  • Parameters:

    • Path:
    Name Type Description Required
    projectId string The id of the project of the row that is going to be updated. ✔️
    blockId string The id of the block of the row that is going to be updated. ✔️
    rowId string The id of the row that is going to be updated. ✔️
    • Header:
    Name Type Description Required
    Authorization string Your Bearer Token obtained in the Auth Token endpoint. ✔️
    • Body:
    Name Type Description Required
    description string Row description.
    columns array Row columns.

  • Example:

curl -XPUT -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" -d '{ "description": "Updated description" }' 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657'
1

Retrieve

You can use this endpoint to retrieve a row.

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

{
  "_id": "5cb869d232f905001a024657",
  "description": "New row",
  "columns": [ columnSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9

  • Parameters:

    • Path:
    Name Type Description Required
    projectId string The id of the project of the row that is going to be retrieved. ✔️
    blockId string The id of the block of the row that is going to be retrieved. ✔️
    rowId string The id of the row that is going 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'
1
Edit this page on GitHub
Last Updated: 4/29/2019, 10:36:29 AM

← Columns →