Skip to content
spirby spirby docs

Update a post

PATCH
/v1/posts/{postId}
 
curl --request PATCH \
  --url https://api.spirby.com/v1/posts/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "body": { "json": "example", "text": "" }, "hideFromRoadmap": true, "slug": "example", "status": "open", "tagIds": [ "example" ], "title": "example" }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
postId
required
string
>= 1 characters

Request Body

Section titled “Request Body ”
Media type application/json
object
body
object
json
text
string
"" <= 50000 characters
hideFromRoadmap
boolean
slug
string
>= 1 characters <= 80 characters /^[a-z0-9]+(?:-[a-z0-9]+)*$/
status
string
Allowed values: open under_review planned in_progress shipped declined duplicate
tagIds
Array<string>
<= 3 items
title
string
>= 1 characters <= 200 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful response

Media type application/json
object
data
Example generated
{
  "data": "example"
}

401

Section titled “401 ”

Missing or invalid API key

Media type application/json
object
error
required
object
code
required
string
details
object
key
additional properties
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "details": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}

403

Section titled “403 ”

Scope insufficient (ERR_SCOPE_INSUFFICIENT) or org in readonly billing state (ERR_FORBIDDEN)

Media type application/json
object
error
required
object
code
required
string
details
object
key
additional properties
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "details": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}

422

Section titled “422 ”

Validation failed

Media type application/json
object
error
required
object
code
required
string
details
object
key
additional properties
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "details": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}

429

Section titled “429 ”

Rate limit exceeded

Media type application/json
object
error
required
object
code
required
string
details
object
key
additional properties
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "details": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}

500

Section titled “500 ”

Internal error

Media type application/json
object
error
required
object
code
required
string
details
object
key
additional properties
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "details": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}