Skip to main content
POST
/
post
curl --request POST \
  --url https://api.sendx.io/api/v1/rest/post \
  --header 'Content-Type: application/json' \
  --header 'X-Team-ApiKey: <api-key>' \
  --data '
{
  "name": "launch_draft_2025",
  "postTitle": "Upcoming Product Launch"
}
'
{
  "id": "post_XyZ123aBc456DeF789GhI",
  "name": "Summer Product Launch",
  "postTitle": "Introducing Our New Summer Collection",
  "postDescription": "<string>",
  "postCategory": "post_category_YzS1wOU20yw87UUHKxMzwn",
  "member": "member_JkL012MnO345PqR678",
  "postThumbnail": "<string>",
  "isPublished": true,
  "includedTags": [
    "post_tag_123XyZ456AbC"
  ],
  "postSlug": "introducing-summer-collection",
  "status": 123,
  "pageTitle": "<string>",
  "pageDescription": "<string>",
  "pageKeywords": "<string>",
  "socialTitle": "<string>",
  "socialDescription": "<string>",
  "socialImageUrl": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}
The post can be saved as a draft (isPublished: false) or published immediately (isPublished: true). You can associate it with a category, author, thumbnail, HTML content, tags, and provide SEO/social metadata for enhanced visibility. 🎯 Key Features:
  • Rich content editor
  • SEO optimization
  • Social media settings
  • Category and tag support
🔍 Use Cases
  1. Create a Draft Post for Future Publishing Save an unpublished draft with just the title, description, and category.
  2. Publish a Post with Complete Metadata Include SEO tags, author, tags, and publish the post immediately.
  3. Save a Post with Custom Slug and Thumbnail Customize the URL and add branding visuals.

Authorizations

​
X-Team-ApiKey
string
header
required

Team API key for authentication. Find your API key in SendX Settings → Team API Key.

Example:

X-Team-ApiKey: your_team_api_key_here

Body

application/json
​
name
string
required

Internal post name

Example:

"Summer Product Launch"

​
postTitle
string
required

Public post title

Example:

"Introducing Our New Summer Collection"

​
postDescription
string

Post excerpt/description

​
postCategory
string

Category ID (with or without prefix)

Example:

"post_category_YzS1wOU20yw87UUHKxMzwn"

​
member
string

Author member ID

Example:

"member_JkL012MnO345PqR678"

​
postThumbnail
string<uri>

Thumbnail image URL

​
postHtml
string

Post HTML content

​
postTemplate
string

Post template

​
isPublished
boolean
default:false

Publication status

​
includedTags
string[]

Post tag IDs

​
editorType
integer
default:1

Editor type used

​
postSlug
string

URL slug

Example:

"introducing-summer-collection"

​
status
integer
default:1

Post status

​
pageTitle
string

SEO page title

​
pageDescription
string

SEO meta description

​
pageKeywords
string

SEO keywords

​
socialTitle
string

Social media title

​
socialDescription
string

Social media description

​
socialImageUrl
string<uri>

Social media image URL

Response

✅ Post created successfully

​
id
string
Example:

"post_XyZ123aBc456DeF789GhI"

​
name
string
Example:

"Summer Product Launch"

​
postTitle
string
Example:

"Introducing Our New Summer Collection"

​
postDescription
string
​
postCategory
string
Example:

"post_category_YzS1wOU20yw87UUHKxMzwn"

​
member
string
Example:

"member_JkL012MnO345PqR678"

​
postThumbnail
string<uri>
​
isPublished
boolean
​
includedTags
string[]
​
postSlug
string
Example:

"introducing-summer-collection"

​
status
integer
​
pageTitle
string
​
pageDescription
string
​
pageKeywords
string
​
socialTitle
string
​
socialDescription
string
​
socialImageUrl
string<uri>
​
created
string<date-time>
​
updated
string<date-time>