Skip to main content

Create a Post

POST 

/api/v2/posts

Create a Post

Request

Body

required

    business_search

    object

    business__in string[]

    Filter by business ids

    publishers string[]required

    Possible values: [google_my_business, facebook]

    List of publisher to diffuse the post

    data

    object

    required

    summary string

    Main text content of the post.

    image_url string

    URL of the image displayed with the post.

    title string

    Title of the post.

    link

    object

    Link displayed in the post to redirect the client clicking on it. Use can only have one of the following parameters ('use_business_url' or 'custom_url').

    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

    coupon_code string

    Offer code that is usable in store or online

    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

    offer_terms string

    Terms and conditions of the offer

    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.

Responses

This endpoint lets you create a Post on Google / Facebook.

The creation will not happen in real time and might take a few minutes.

Schema

    data string[]

    Post ID and relative business ID pair list

    status string

    Request status

    code number

    Request code

    message string

    Number of post(s) created

Loading...