{
    "status": "success",
    "errors": [],
    "postIds": [
        {
            "status": "success",
            "id": "1288899996423983105",
            "platform": "twitter",
            "postUrl": "https://twitter.com/handle/status/1288899996423983105"
        },
        {
            "status": "success",
            "id": "104923907983682_108329000309742",
            "platform": "facebook",
            "postUrl": "https://www.facebook.com/104923907983682_108329000309742",
        },
        {
            "status": "success",
            "platform": "instagram",
            "id": "17878176260289172",
            "postUrl": "https://www.instagram.com/p/CP1dI9Hp_WO/",
            "usedQuota": 12
        }
    ],
    "id": "RhrbDtYh7hdSMc67zC8H"
}

{
    "status": "error",
    "errors": [
        {
            "action": "post",
            "status": "error",
            "code": 156,
            "message": "Youtube does not seem to be linked with Ayrshare. Please confirm the linkage on the Social Accounts page in your dashboard. https://docs.ayrshare.com/additional-info/troubleshooting",
            "platform": "youtube"
        },
        {
            "action": "post",
            "status": "error",
            "code": 110,
            "message": "Status is a duplicate.",
            "post": "Today is a great day",
            "platform": "twitter"
        },
    ],
    "postIds": [],
    "id": "0OGBzZssN5hxy8dMSRaD"
}

{
    "status": "error",
    "errors": [
        {
            "action": "post",
            "status": "error",
            "code": 107,
            "message": "Facebook Error: This status update is identical to the last one you posted. Try posting something different, or delete your previous update.",
            "platform": "facebook"
        }
    ],
    "postIds": [],
    "id": "6APU4qqI7XO7JM3BOy6B"
}

Request Examples

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"post": "Today is a great day!", "platforms": ["twitter", "facebook", "instagram", "linkedin"], "mediaUrls": ["https://images.ayrshare.com/imgs/GhostBusters.jpg"]}' \
-X POST https://app.ayrshare.com/api/post

const fetch = require("node-fetch");
const API_KEY = "API_KEY";
​
fetch("https://app.ayrshare.com/api/post", {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({
        post: "Today is a great day!", // required
        platforms: ["twitter", "facebook", "instagram", "linkedin"], // required
        mediaUrls: ["https://images.ayrshare.com/imgs/GhostBusters.jpg"], //optional
      }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

import requests
​
payload = {'post': 'Today is a great day!', 
        'platforms': ['twitter', 'facebook', 'instagram', 'linkedin'],
        'mediaUrls': ['https://images.ayrshare.com/imgs/GhostBusters.jpg']}
headers = {'Content-Type': 'application/json', 
        'Authorization': 'Bearer API_KEY'}
​
r = requests.post('https://app.ayrshare.com/api/post', 
    json=payload, 
    headers=headers)
    
print(r.json())

<?php
require 'vendor/autoload.php';     // Composer auto-loader
​
$client = new GuzzleHttp\Client(); // Use the HTTP library of your choice
$res = $client->request(
    'POST',
    'https://app.ayrshare.com/api/post',
    [
        'headers' => [
            'Content-Type'      => 'application/json',
            'Authorization'     => 'Bearer API_KEY'
        ],
        'json' => [
            'post' => 'Today is a great day!', // required
            'platforms' => ['twitter', 'facebook', 'instagram', 'linkedin'], // required
            'mediaUrls' => ['https://images.ayrshare.com/imgs/GhostBusters.jpg'], // optional
        ]
    ]
);
​
echo json_encode(json_decode($res->getBody()), JSON_PRETTY_PRINT); 

package main
​
import (
	"bytes"
	"encoding/json"
	"log"
	"net/http"
)
​
func main() {
	message := map[string]interface{}{
		"post":      "Today is a great day!",
		"platforms": []string{"twitter", "facebook", "instagram", "linkedin"},
		"mediaUrls": []string{"https://images.ayrshare.com/imgs/GhostBusters.jpg"}
	}
​
	bytesRepresentation, err := json.Marshal(message)
	if err != nil {
		log.Fatalln(err)
	}
​
	req, _ := http.NewRequest("POST", "https://app.ayrshare.com/api/post",
		bytes.NewBuffer(bytesRepresentation))
​
	req.Header.Add("Content-Type", "application/json; charset=UTF-8")
	req.Header.Add("Authorization", "Bearer API_KEY")
​
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal("Error:", err)
	}
​
	res.Body.Close()
}

using System;
using System.Net;
using System.IO;
​
namespace PostPOSTRequest_charp
{
    class Post
    {
        static void Main(string[] args)
        {
            string API_KEY = "API_KEY";
            string url = "https://app.ayrshare.com/api/post";
​
            var httpWebRequest = WebRequest.CreateHttp(url);
            httpWebRequest.ContentType = "application/json";
            httpWebRequest.Method = "POST";
            httpWebRequest.Headers.Add("Authorization", "Bearer " + API_KEY);
​
            using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
            {
                string json = "{\"post\" : \"Today is a great day!\","
                    + "\"platforms\" : [ \"twitter\", \"facebook\", \"instagram\", \"linkedin\" ]," 
                    + "\"mediaUrls\" : [ \"https://images.ayrshare.com/imgs/GhostBusters.jpg\" ]}";
​
                streamWriter.Write(json);
                streamWriter.Flush();
            }
​
            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}

Additional Endpoint Examples

Instagram

Post images or videos directly to Instagram.

Instagram has the following requirements and restrictions:

• Business Instagram Account connected with a Facebook Page - see here.

• Only 25 Instagram posts are allowed over a 24 hour period - around 750 posts a month. See below for usedQuota

• The post text may contain up to 30 hashtags (e.g. #wildtimes) and 20 username mentions (e.g. @natgeo).

• @Mentioned Instagram users will receive a notification.

• Maximum 2,200 post characters, 30 hashtags, and 20 @ tags.

• Multi-image posts are not supported.

• Delete not supported using the /delete endpoint.

Note: The aspect ratio of images & videos and the duration of video are very important to successfully post to Instagram. If they do not meet the requirements, the post will be rejected.

Please see the Instagram section of Image and Video Guidelines:

​

Instagram Business Account

Your Instagram account must be a Business Account and connected with a Facebook Page. The setup is free and easy.

See here for detailed instructions:

​

Additional Post Parameters - User Tags and Location

An image can be tagged with Instagram users and images/videos can be tagged with a location, for a given Facebook Page Id, using the instagramOptions parameter.

In the following example, a location is specified by a locationId, which is a Facebook Page Id of the Guggenheim Museum. Users are specified by a userTags containing an Array of objects with an Instagram username and x/y coordinates on the image.

• Usernames must be public Instagram accounts.

• x and y values must be float numbers that originate from the top-left of the image, with a range of 0.0–1.0.

{
    "post": "Let it go!",
    "platforms": [
        "instagram"
    ],
    "mediaUrls": [
        "https://images.ayrshare.com/imgs/GhostBusters.jpg"
    ],
    "instagramOptions": {
        "locationId": 7640348500,
        "userTags": [
            {
                "username": "ayrshare",
                "x": 0.5,
                "y": 0.5
            },
            {
                "username": "ayrshare",
                "x": 0.3,
                "y": 0.2
            }
        ]
    }
}

​

Post Response

The Instagram response will include the current usedQuota for the number of Instagram posts done over a rolling 24-hours period. Only 25 Instagram posts are permitted by Instagram in a 24-rolling-hour period.

{
    "status": "success",
    "errors": [],
    "postIds": [
        {
            "status": "success",
            "id": "17823977408036085",
            "usedQuota": 15,
            "platform": "instagram"
        }
    ],
    "id": "l4FaPHSXWJNdmMfm3dIE"
}

If the quota has been reached, an error message will be returned.

​

Facebook

Carousel Images

Post Facebook Carousel images through Ayrshare's API with the carousel body parameter.

{
  "faceBookOptions": {
    "carousel": {
      "link": "URL of See More At...",
      "items": [
        {
          "name": "Image name",
          "link": "URL when image clicked",
          "picture": "URL of image"
        },
        {
          "name": "Image name",
          "link": "URL when image clicked",
          "picture": "URL of image"
        }
      ]
    }
  }
}

The top-level link parameter is the URL at the end of the carousel.

The items is an array of object containing the picture URL, link URL when the image is clicked, and name of the image displayed in each image card. At least two object must be present in the items array.

Note: Do not use the media_urls with carousel. If media_urls is used, carousels will be ignored.

Please see our Facebook Carousel Blog Post for more information.

​

Media Captions

Set a caption for each Facebook media image posted.

Accepts an array of string caption text. Each array must correspond to a media url. E.g. ["This is my best pic", "😃 here is the next one"] refers to the 1st and 2nd urls in mediaUrls.

{
  "faceBookOptions": {
    "mediaCaptions": ["This is my best pic", "😃 here is the next one"]
  }
}

​

Page Mentions

You can mention another Facebook Page by including the following in the post text. Note, Premium or Business Plan required for mentions.

@[page-id]

An example post text: "This is the best post by @[109905187950644]".

The Facebook Page id will resolve to the matching page and notify the other page of mention.

To find your Page ID:

1. From News Feed, click Pages in the left side menu.

2. Click your Page name to go to your Page.

3. Click About at the top of your Page. If you don't see it, click More.

4. Scroll down to find your Page ID below MORE INFO.

​

YouTube

The following are required body parameters. Please see the comments for requirements.

Premium or Business Plan required.

{
    post: "YouTube Description",      // required: Video description
    platforms: ["youtube"],           // required
    mediaUrls: ["https://images.ayrshare.com/imgs/test-video-1.mp4"], // required: URL of video, 1 allowed               
    youTubeOptions: {
        title: "YouTube Title",       // required: Video Title
        youTubeVisibility: "private", // optional: "public", "unlisted", or "private" - default "private"
        /** Important Thumbnail information below **/
        thumbNail: "https://images.ayrshare.com/imgs/GhostBusters.jpg", // optional: URL of a JPEG or PNG and less than 2MB
        playListId: "PLrav6EfwgDX5peD7Ni-pOKa7B13WjLyUB" // optional: Playlist ID to add the video
    }
}

​

Thumbnail Requirements

Thumbnails and other features, such as uploading 15 minute videos, require verification of your phone number. Thumbnails must be less than 2 MB in size.

In "YouTube Studio" go to "Setting" -> "Channel". Select "Feature Eligibility" and click "Features that require phone verification". Enter your phone number to enable.

​

Video: Posting to YouTube via the API

​

Google My Business (GMB)

There are four types of GMB posts. In the below example, the post text is the summary of the GMB update. Find out more about Google My Business.

Image or Video

An image or video can be added to your GMB location. Only one image or video is allowed per post. Note, the post text is not used, but required by the endpoint. For example, a restaurant can make a post to promote a new menu item.

{
    "post": "What an image!",
    "platforms": ["gmb"],
    "mediaUrls": ["https://images.ayrshare.com/imgs/ayrshare-code-ex.jpg"] // required
}

Events

Promote an event at your business. Events require a title, start and end dates, and can include a video. For example, a real estate agent may advertise an open house showing signing.

Include an image with the mediaUrls parameter. Videos are not supported for Events.

{
    "post": "A great event!",
    "platforms": ["gmb"],
    "mediaUrls": ["https://images.ayrshare.com/imgs/ayrshare-code-ex.jpg"], // optional
    "gmbOptions": {
        "event": {
            "title": "Check this event out.", // required
            "startDate": "2021-08-12T20:17:46.384Z", // required
            "endDate": "2021-09-12T20:17:46.384Z" // required
        }
    }
}

Call to Action

Provide general information about your business. You can include a photo or video, a description, and an action button. For example, a website might promote a learn more about our SaaS platform.

Include an image with the mediaUrls parameter. Videos are not supported for Call to Actions.

{
    "post": "Take this action!",
    "platforms": ["gmb"],
    "mediaUrls": ["https://images.ayrshare.com/imgs/ayrshare-code-ex.jpg"], //optional
    "gmbOptions": {
        "callToAction": {
            "actionType": "order",    // required
            "url": "https://www.ayrshare.com" // required
        }
    }
}

The actionType is displayed as a button on the post. Possible values are:

• book: Prompts a user to book an appointment, table, or something similar.

• order: Prompts a user to order something.

• shop: Prompts a user to browse a product catalog.

• learn_more: Prompts a user to see additional details on a website.

• sign_up: Prompts a user to register, sign up, or join something.

• call: Prompts a user to call a business.

The url parameter is the URL the user will be directed to upon clicking.

Offers

Provide promotional sales or offers from your business. Offers require a title as well as start and end dates and times. A "View offer" action button is automatically added to the post. You can also include a photo, video, description, coupon code, link, and terms and conditions with the post. For example, a toy store may advertise 20% off all beanie babies for a week.

Include an image with the mediaUrls parameter. Videos are not supported for Offers.

{
    "post": "A great offer for everyone!",
    "platforms": ["gmb"],
    "gmbOptions": {
        "offer": {
            "title": "Great Sale.", // required
            "startDate": "2021-08-12T20:17:46.384Z", // required
            "endDate": "2021-09-12T20:17:46.384Z", // required
            "couponCode": "BOGO-JET-CODE", // required
            "redeemOnlineUrl": "https://www.ayrshare.com", // required
            "termsConditions": "Offer only valid if you can prove you are a time traveler"  // required
        }
    }
}

Reddit

The following are required body parameters for posting to Reddit. Please be sure the subreddit allows automated posting.

{
    post: "Reddit post",                // required
    platforms: ["reddit"],              // required
    redditOptions: {
        title: "Reddit Post Title",     // required
        subreddit: "test",              // required (no "/r/" needed)
        reddit_link: "https://www.website.com", // optional: post a link 
    } 
}

• subreddit: The subreddit to send the post. Please be sure to follow the subreddit's posting guidelines. A good subreddit to use for testing is /r/test/

• reddit_link: If posting to Reddit and you want to post a link instead of text to the subreddit.

​

Profile Keys

Post to on behalf of user by providing users' Profile Keys a a body parameter. Please see here for details. Business Plan required.

​

Image and Video Requirements

Posting images and videos have different requirements for each network. See below for details, but don't worry. Our system verifies your post before sending, so you'll get an error response if something is wrong.

​

Auto Hashtags

Adds the the post relevant hashtags. Takes into account real-time hashtag popularity.

autoHashtag is an object with the following parameters:

• max: (optional) Integer of hashtags to add, range 1-5. Default 2.

• position: (optional) String "auto" or "end". Auto adds the hashtags within the post or to the end. "end" adds hashtags just to the end.

Post max length 1,000 characters, else hashtags will not added.

Premium or Business Plan required.

{ 
    max: 3,              // optional: Integer range 1-5
    position: "auto"     // optional: String "auto" or "end"
}

​

Unsplash

Auto add Unsplash Image Parameters

The following fields are available for the unsplash body parameter:

• Random Image: random returns a random Unsplash image.

• Search Based Image: value String search term ; e.g. money will select a random image based on money.

• Image IDs: value Array of Ids [ids]; e.g. ["HubtZZb2fCM"] of image https://unsplash.com/photos/HubtZZb2fCM​

unsplash: "random"
unsplash: "search term"           // unsplash: "money" 
unsplash: ["unsplash image ID"]   // unsplash: ["HubtZZb2fCM"]

​

Ads

Take your or your users' posts to the next level my promoting them as ads. We currently only support Twitter Promoted Tweets, but additional networks are coming soon.

{
    "post": "Today is a great day!",
    "platforms": [
        "twitter"
    ],
    "ads": {
        "twitter": {
            "campaign": "19ce55aplcy",
            "group": "it9bm"
        }
    }
}

Promoting a post as an add requires two parameters: campaign and group ids. When the post successfully is sent, it will be promoted as an ad in the given campaign and group.

If the campaign and group ids were preset with the PUT /ads/twitter/ids endpoint, use the createAd parameter to automatically promote the post.

{
    "post": "Today is a great day!",
    "platforms": [
        "twitter"
    ],
    "ads": {
        "twitter": {
            "createAd": true
        }
    }
}

Please see the ads docs for more details:

Use Pre-Set Campaign and Group Ids

Preset the campaign and group ids with the /ads/twitter/ids endpoint and automatically use these ids when posting and promoting a Tweet with the createAd boolean parameter. You do not need to send the campaign or group ids.

{
    "post": "Today is a great day!",
    "platforms": [
        "twitter"
    ],
    "ads": {
        "twitter": {
            "createAd": true
        }
    }
}

{
    "twitter": {
        "action": "delete",
        "status": "success",
        "id": "1288900099663775749"
    },
    "facebook": {
        "action": "delete",
        "status": "success",
        "id": "104920007983682_108683297607743"
    },
    "status": "success"
}

​

Request Examples

curl \
-H "Authorization: Bearer API Key" \
-H 'Content-Type: application/json' \
-d '{"id": "Post ID"}' \
-X DELETE https://app.ayrshare.com/api/post

const fetch = require("node-fetch");
const API_KEY = "API_KEY";
const id = "Post ID";
​
fetch("https://app.ayrshare.com/api/post", {
      method: "DELETE",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({ id }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

import requests
​
payload = {'id': 'Post ID'}
headers = {'Content-Type': 'application/json', 
        'Authorization': 'Bearer API_KEY'}
​
r = requests.delete('https://app.ayrshare.com/api/post', 
    json=payload, 
    headers=headers)
    
print(r.json())

<?php
require 'vendor/autoload.php';   // Composer auto-loader
​
$client = new GuzzleHttp\Client();
$res = $client->request(
    'DELETE',
    'https://app.ayrshare.com/api/post',
    [
        'headers' => [
            'Content-Type'      => 'application/json',
            'Authorization'     => 'Bearer API_KEY'
        ],
        'json' => [
            'id' => ['7NFVK0QIXET5rCUS9tmf']   // top-level id from post request
        ]
    ]
);
​
echo json_encode(json_decode($res->getBody()), JSON_PRETTY_PRINT); 

using System;
using System.Net;
using System.IO;
​
namespace DeletePOSTRequest_charp
{
    class Delete
    {
        static void Main(string[] args)
        {
            string API_KEY = "API_KEY";
            string url = "https://app.ayrshare.com/api/post";
​
            var httpWebRequest = WebRequest.CreateHttp(url);
            httpWebRequest.ContentType = "application/json";
            httpWebRequest.Method = "DELETE";
            httpWebRequest.Headers.Add("Authorization", "Bearer " + API_KEY);
​
            using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
            {
                string json = "{\"id\" : \"Post ID\"}";
​
                streamWriter.Write(json);
                streamWriter.Flush();
            }
​
            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}

​

Delete Profile Posts

Delete a post for a particular user profile by passing the profileKeys parameter as a body parameter.

Available for Business Plan users only.

const fetch = require("node-fetch");
const API_KEY = "API_KEY";
const PROFILE_KEY = "PROFILE_KEY";
const id = "Post ID";
​
fetch("https://app.ayrshare.com/api/post", {
      method: "DELETE",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({ 
        profileKeys: PROFILE_KEY,  // a single Profile Key passed as a String
        id 
      }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);