# Columns

# Create

You can use this endpoint to create a column.

• Endpoint:

POST https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns

• Response:

Status: 201

{
  "_id": "5cc0ac42003a7c001ab5c95a",
  "size": "12",
  "contents": [ contentSchema ],
}

• Parameters:

  • Path:

  Name	Type	Description	Required
  projectId	string	The id of the project of the column that is going to be created.	✔️
  blockId	string	The id of the block of the column that is going to be created.	✔️
  rowId	string	The id of the row of the column 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
  size	number	Column size (min 1 and max 12), the sum of the sizes of the columns of a row must not exceed 12.	✔️
  contents	array	Column contents.

• Example:

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

# Delete

You can use this endpoint to delete a column.

• Endpoint:

DELETE https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns/<columnId>

• Response:

Status: 204 (no-content)

• Parameters:

  • Path:

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

# List

You can use this endpoint to list the columns of a row.

• Endpoint:

GET https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns

• Response:

Status: 200

{
  [
    { ... },
    {
      "_id": "5cc0ac42003a7c001ab5c95a",
      "size": "12",
      "contents": [ contentSchema ],
    },
    { ... }
  ]
}

• 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.	✔️
  rowId	string	The id of the row of the column that 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'

# Update

You can use this endpoint to update a column.

• Endpoint:

PUT https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns/<columnId>

• Response:

Status: 200

{
  "_id": "5cc0ac42003a7c001ab5c95a",
  "size": "12",
  "contents": [ contentSchema ],
}

• Parameters:

  • Path:

  Name	Type	Description	Required
  projectId	string	The id of the project of the column that is going to be updated.	✔️
  blockId	string	The id of the block of the column that is going to be updated.	✔️
  rowId	string	The id of the row of the column that is going to be updated.	✔️
  columnId	string	The id of the column 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
  size	number	Column size (min 1 and max 12), the sum of the sizes of the columns of a row must not exceed 12.
  contents	array	Column contents.

• Example:

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

# Retrieve

You can use this endpoint to retrieve a column.

• Endpoint:

GET https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns/<columnId>

• Response:

Status: 200

{
  "_id": "5cc0ac42003a7c001ab5c95a",
  "size": "12",
  "contents": [ contentSchema ],
}

• Parameters:

  • Path:

  Name	Type	Description	Required
  projectId	string	The id of the project of the column that is going to be retrieved.	✔️
  blockId	string	The id of the block of the column that is going to be retrieved.	✔️
  rowId	string	The id of the row of the column that is going to be retrieved.	✔️
  columnId	string	The id of the column 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/columns/5cc0ac42003a7c001ab5c95a'