Skip to main content

Update a Post

PUT 
/api/v2/posts/:post_id

Update a Post

Request​

Path Parameters

    post_id stringrequired

Body

required

    summary string

    Main text content of the post.

    offer_term string

    Terms and conditions of the offer

    title string

    Title 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

    Use the business google url for link on the post.

    custom_url string

    An URL to redirect client when they click on the button

    schedule_time date-time

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

    start_at date-time

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

    end_at date-time

    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

Responses​

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

Schema

    summary string

    Main text content of the post.

    id number

    The Post id

    business_id string

    Business id

    title string

    The title of the post

    post_type string

    Possible values: [standard, event, offer, alert]

    The type of the post to be created. Event and Offer are not yet available for Facebook.

    start_at date-time

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

    end_at date-time

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

    schedule_time date-time

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

    post_medias

    object[]

    @description The photo that will be on the Post

  • Array [

    • media_url string

    URL of the image displayed with the post.

  • ]

    • created_at date-time

    Creation date

    updated_at date-time

    Last update date (either on our platform or on Partner platform)

    business_info string

    name and address of the business that the post is related to.

    post_insight

    object[]

    Statistics related to the posts on the different platforms.

    ⚠️ Due to a Google deprecation, on 20/02/2023, Google views and counts won't be available anymore. Old insights will still be sent. Facebook ones will still be available.

  • Array [

    • name string

    Possible values: [google_my_business__posts, facebook__posts]

    Publisher related to the post

    click_count number

    number of times a user has clicked on the post.

    view_count number

    number of times the post has been viewed.

  • ]

    • post_status

    object[]

    Status related to the posts on the different platforms.

  • Array [

    • name string

    Possible values: [google_my_business__posts, facebook__posts]

    Publisher related to the post

    state string

    Possible values: [live, to_configure, pending, scheduled, error, expired]

    The state of the post, indicating at which lifecycle stage it is currently.

    link string

    Link displayed in the post to redirect the client clicking on it.

  • ]

    • offer_terms string

    Terms and conditions of the offer

    offer_code string

    Offer code that is usable in store or online

    cta_link string

    Link displayed in the post to redirect the client clicking on it.

    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.

Loading...