Create a Post

POST 
/api/v2/posts

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

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

Request

application/json

Body

required

business_search

object

required

business__in string[]required

Create posts for given businesses

publishers string[]required

Possible values: [google_my_business, facebook, instagram]

data

object

required

post_type stringrequired

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

summary stringrequired

Main text content of the post.

title string

The title of 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.

schedule_time string

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

offer_terms string

Terms and conditions of the offer

start_at string

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

end_at string

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

image_url string

URL of the image displayed with the post.

link

object

use_business_url boolean

custom_url string

coupon_code string

Offer code that is usable in store or online

Responses

201

application/json

Schema

Schema

status string

Request status

code integer

Request code

message string

Number of post(s) created

data

object[]

Post ID and relative business ID pair list

Array [

post_id integerrequired

business_id stringrequired

]

Example (from schema)

{
  "status": "OK",
  "code": 200,
  "message": "2 posts have been created.",
  "data": [
    {
      "post_id": 101,
      "business_id": "1234567890"
    },
    {
      "post_id": 102,
      "business_id": "1234567891"
    }
  ]
}

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