Update a Post

PUT 
/api/v2/posts/:post_id

This endpoint lets you update a Post. The update will not happen in real time and might take a few minutes

Request

Path Parameters

post_id integerrequired

application/json

Body

required

title stringnullable

The title of the post

summary stringrequired

Main text content of the post.

image_url string

URL of the image displayed with the post.

cta_type string

Possible values: [book, order, shop, learn_more, sign_up, call, no_cta]

The type of the post to be created. Some type mig.

link

object

use_business_url boolean

custom_url string
schedule_time stringnullable

Date when the Post will be published. No scheduled start time means that the Post will be published immediately.

start_at stringnullable

For either event or offer post type. Defined when it start. Timezone is defined by the business timezone.

end_at stringnullable

For either event or offer post type. Defined when it end. Timezone is defined by the business timezone.

coupon_code string

Offer code that is usable in store or online

offer_term string

Terms and conditions of the offer

Responses

200

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...