Create a post

Creates a new post on a board. Returns a post object.

📘
API key
You will need to include your API key found here.
Please include the key in your header. {"X-API-KEY": <api_key>}

🔒
Authorization required
This endpoint requires admin access to the board. You must be an admin or owner of the board to access its data.

An example of a basic request body is displayed below. It follows the JSON:API specification.

{
  "data": {
    "type": "post",
    "attributes": {
      "content": {
        "subject": "Test post",
        "body": "Created using the API!",
        "attachment": {
          "url": "http://example.com",
          "caption": "Example website"
        }
      },
      "color": "red",
      "customFields": {
        "field_abc123": "High Priority",
        "field_def456": "Project Alpha"
      }
    },
    "relationships": {
      "section": {
        "data": {
          "id": "abcd1234efgh5678"
        }
      }
    }
  }
}

Body parameters

* required

**affects posts in certain formats

Properties	Type	Description
`type**`	`string`	Type should be set to `post`.
`attributes.content*`	`object`	Content object holding subject, body and attachment information. `content.subject` denotes the subject of the post. `content.body` denotes the body of the post. `content.attachment` is the attachment object of the post. Currently only supports url links and poll attachments. One of subject, body or attachment is required to make a successful post request.
`attributes.color`	`string`	Color of the post. Allowed values are `red`,`orange`,`green`,`blue`,`purple`.
`attributes.manualSortPosition`	`object` `previousPostId`:`string`	Sets the position of the post relative to the post that comes before it. `previousPostId` denotes the post that is on top or to the left of the post you are creating.
`attributes.mapProps**`	`object` `latitude`:`float` `longitude`:`float` `locationName`:`string`	Map properties of a post. Only affects posts in boards of map format. `mapProps.latitude` denotes the latitude of the post in Padlet map format. `mapProps.longitude` denotes the longitude of the post in Padlet map format. `mapProps.locationName` denotes the custom location name. Both latitude and longitude must be present to use `mapProps`.
`attributes.canvasProps**`	`object` `left`:`int` `right`:`int` `width`:`int`	Canvas property of a post. Only affects posts in boards of canvas format. `canvasProps.left` denotes the left position of the post in Padlet canvas format. `canvasProps.top` denotes the top position of the post in Padlet canvas format. `canvasProps.width` denotes the width of the post. All 3 are needed to use `canvasProps`
`attributes.customFields`	`object`	Custom field values for this post. Keys should be the custom field IDs configured for the board, and values should be the field values. Custom field IDs can be obtained from the board's `customFields` attribute.
`relationships.section`	`string`	The section which the post belongs to. `section.data.id` must belong to the wall. You can get this information via our get board by id call with `include=sections` query params.