POST /v1/social/{accountNumber}/schedule

Servers

Path parameters

Name Type Required Description
accountNumber Number Yes

Id of the Account.

Request headers

Name Type Required Description
api_key String No

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

Accept String No

e.g. application/json

Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
socialSite String Yes

Social Sites. Possible values are

                            INSTAGRAM,
                            FACEBOOK,
                            GOOGLEMYBUSINESS,
                            LINKEDIN,
                            TWITTER
text String Yes

Input text that will be added in the post. Limits of characters across various Social Sites

            Google Business Profile: 1500
            Facebook: 5000
            Instagram: 5000
            LinkedIn: 3000
            Twitter: 240
additionalMetaData Object No

Applicable only for GOOGLEMYBUSINESS, learn more link.

additionalMetaData.callToActionType String No

Type of data.

additionalMetaData.callToActionUrl String No

Link of the additional data.

media Object No

Media details.

media.type String No

Type of Media. IMAGE or VIDEO

media.mediaUrl String No

Media Link.

subBusinessNumbers[] Array No

List of Location Ids. Optional for SMB.

scheduleTimestamp Number No

Epoch time in milliseconds.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.