Skip to main content
PUT
Update post

Authorizations

X-Team-ApiKey
string
header
required

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

Example:

Path Parameters

identifier
string
required

Resource identifier with prefix (e.g., contact_BnKjkbBBS500CoBCP0oChQ)

Format: <prefix>_<22-character-id>

Pattern: ^[a-z_]+_[a-zA-Z0-9]{22}$
Example:

"contact_BnKjkbBBS500CoBCP0oChQ"

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 updated 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>