post

Schedule posts, auto hashtag, auto-post schedule, and more: Facebook Pages, Instagram, LinkedIn, X/Twitter, Pinterest, YouTube, Telegram, Google Business Profile, Reddit, & TikTok.

POST Send a Post

POST https://app.ayrshare.com/api/post

Post to the social networks you have enabled in the web dashboard. If you want to post to one or many client profiles, please see the /profiles endpoint. Please be sure to add your API KEY in place of API_KEY in the Authorization header. The API Key can be found in the Ayrshare Developer Dashboard under the API Key page.

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "status": "success",
    "errors": [],
    "postIds": [
        {
            "status": "success",
            "id": "1288899996423983105", // Twitter Social ID
            "platform": "twitter",
            "postUrl": "https://twitter.com/handle/status/1288899996423983105"
        },
        {
            "status": "success",
            "id": "104923907983682_108329000309742", // Facebook Social ID
            "platform": "facebook",
            "postUrl": "https://www.facebook.com/104923907983682_108329000309742",
        },
        {
            "status": "success",
            "platform": "instagram", // Instagram Social ID
            "id": "17878176260289172",
            "postUrl": "https://www.instagram.com/p/CP1dI9Hp_WO/",
            "usedQuota": 12
        },
        {
            "status": "success",
            "id": 635, // Telegram Social ID
            "postUrl": "https://t.me/c/1424847122/635",
            "platform": "telegram"
        }
    ],
    "id": "RhrbDtYh7hdSMc67zC8H"    // Ayrshare Post ID used for delete, analytics, comments, etc.
}

{
    "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" // Ayrshare Post ID used for delete, comment, analytics, etc.
}

{
    "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" // Ayrshare Post ID used for delete, comment, analytics, etc.
}

{
    "status": "scheduled",
    "scheduleDate": "2023-04-01T10:04:12Z",
    "id": "IUiaqFkQP96UJJXYjRpv", // Ayrshare Post ID used for delete, comment, analytics, etc.
    "refId": "9abf1426d6ce9122effdeeddfdfdfd",
    "post": "Genius is eternal patience. - Michelangelo"
}

{
    "status": "success",
    "posts": [
        {
            "status": "scheduled",
            "scheduleDate": "2023-04-01T10:04:12Z",
            "id": "qvu8gysraodz2WFZgRX7", // Ayrshare Post ID used for delete, comment, analytics, etc.
            "refId": "9abf1426d6ce9122effdeeddfdfdfd",
            "profileTitle": "Best Profile",
            "post": "I never thought of myself as being handsome or good-looking or whatever. I always felt like an outsider. - Elton John"
        }
    ]
}

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://img.ayrshare.com/012/gb.jpg"]}' \
-X POST https://app.ayrshare.com/api/post

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://img.ayrshare.com/012/gb.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://img.ayrshare.com/012/gb.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

$curl = curl_init();
$data = [
    "post" => "Today is a great day!",
    "platforms" => ["twitter", "facebook", "instagram", "linkedin", "pinterest"],
    "mediaUrls" => ["https://img.ayrshare.com/012/gb.jpg"]
];

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://app.ayrshare.com/api/post',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode($data),
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer API_KEY', // Replace 'API_KEY' with your actual API key
        'Content-Type: application/json'
    ],
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

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://img.ayrshare.com/012/gb.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://img.ayrshare.com/012/gb.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);
            }
        }
    }
}

require 'httparty'    # gem install httparty

res = HTTParty.post("https://app.ayrshare.com/api/post", 
    headers: {Authorization: "Bearer API_KEY"}, 
    body: {
        post: "Today is a great day!", 
        platforms: ['twitter', 'facebook', 'instagram'],
        mediuaUlrs: ["https://img.ayrshare.com/012/gb.jpg"]
    }).body

puts res

Please see the details pages on each social network for examples and options.

pageSocial Networks

Profile Keys

Post to on behalf of user by providing users' Profile Keys a a body parameter and the additional data in the response. Business Plan required.

pageprofiles

Image and Video Requirements

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

pageImage and Video Guidelines

Larger Videos

The app.ayrshare.com domain has a 60 second timeout. If the social network takes an extended period to process a video, an HTTP 500 response may be returned - the video will still be published if no errors occur.

We recommend for larger video files over 25 MB or Facebook/Instagram reels to create a scheduled post with the scheduleDate parameter for async processing or use the beta api.ayrshare.com domain.

Video Extension

If your URL does not end in a known video extension such as mov, you can use the isVideo: true field in the post to specify the mediaUrl is a video . Ayrshare will try to determine the file type, such as MOV. However, we recommend explicitly ending your video file with a known extension, such as mp4, since this has a higher success rate with the social networks.

Image or Video Only

A few social networks support sending media without post text. If you do not want post text included send and empty String post: ""

The following social networks support no post/blank text: Facebook, Instagram, LinkedIn, TikTok, and X/Twitter.

Schedule Posts

You can schedule future posts by specifying the scheduleDate parameter with the datetime in Zulu/UTC. Zulu Time, also known as Coordinated Universal Time (UTC), is the world standard for time.

For example, use format "YYYY-MM-DDThh:mm:ssZ" and send as "2023-07-08T12:30:00Z".

"scheduleDate": "2023-07-08T12:30:00Z"

Please see https://www.utctime.net/

Note: If the scheduled datetime is in the past, the post will immediately be sent.

If a mediaUrl is included with a scheduled post, the media must be available at the scheduled publication time. For example, if the post is scheduled to be published on March 1, the media must be available on March 1.

Auto Hashtags

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

autoHashtag is an object, or Boolean - see below, 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"
}

If you do not want to send any of the above options, pass the Boolean value trueinstead of an object.

"autoHashtag": true

Approval Workflow

If your workflow, often for agencies, requires approval before sending a post, set the requiresApproval field to true. The post will have a status of "awaiting approval" until the approved parameter is set to true via the /post PUT operation.

Publish your post using the /post endpoint with the requiresApproval field as true. You may also including standard parameters such as scheduleDate.
The post will be in a status of "awaiting approval" and will be held until approval is granted.
Update the post with the /post PUT operation setting the approved field as true. The post will now be sent at the scheduled time.
Optional: Set notes on the post for reference, such as who needs to approve the post.

{
    "requiresApproval": true,
    "notes": "need approval by John Smith" // optional
}

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"]

If copying an Unsplash URL to post in mediaUrls, please be sure to copy the image address and not just the URL. Please see this example for more information.

Shorten Links

By default, links in a post are shortened using the Ayrshare link shortner. You can turn off the automatic link shortening with the shortenLinks parameter when sending a post.

{
    "shortenLinks": false
}

Idempotent Posts

Idempotency allows you to safely retry posts without accidentally performing the same operation twice.

Add the optional idempotencyKey body parameter to the /post POST with your key as a unique String.

{
    "idempotencyKey": "Unique Key"
}

The key is unique per User Profile. If a duplicate key for a given User Profile is found an error will be returned.

The post must first be accepted to store the idempotency key and perform the check. Two posts with the same key are sent at the exact same time are not guaranteed to fail.

Advertising

Take your users' posts to the next level by promoting them as ads. see here for more info:

pageads

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

Additional Info

Line Breaks

If you want to line breaks, new lines, in a post, use the invisible line break \u2063\n.For example, This is a new\u2063\nline.

We also recommend trying in Postman to see how the new line break is translated in your language of choice. For example, PHP often only uses a \n

Some social networks do not currently support line breaks in the post text.

Rich Text Posts

You can add rich text such as "𝓗𝓮𝓵𝓵𝓸, how about a little 𝗯𝗼𝗹𝗱 𝘁𝗲𝘅𝘁 and 𝘪𝘵𝘢𝘭𝘪𝘤𝘴 𝘵𝘦𝘹𝘵 and an x₂?". You can use rich text on networks such as Twitter, Facebook, LinkedIn, Telegram, and Instagram. If posting to Reddit, please use Reddit-flavored Markdown formatting.

HTML elements are used to specify the type of rich text, which is translated into unicode. For example:

{
    "post": "<var>Hello</var>, how about a little <b>bold text</b> and <i>italics text</i> and an x<sub>2</sub>?"
    "platforms": ["twitter"]
}

HTML Elements

HTML

Example

Additional CSS Codes

Code

Example

Result

Testing Images and Videos

Consider using the generate random text and random image or video to speed up your testing. Stop trying to think up something different for each of your test posts!

GET Retrieve a Post

GET https://app.ayrshare.com/api/post/:id

Get the history for a specific posts sent via Ayrshare. Returns the status, post parameters, and other details. Replace :id with the Ayrshare Post ID.

Note, you may also call the /history endpoint for the same data.

Post status fields values:

⮕ awaiting approval: Posts are awaiting to be approved via the Approval Workflow.

⮕ deleted: Post has been deleted. Note: deleted posts are only returned with the status query filter. Please see below.

⮕ error: An error occurred with one or more social networks.

⮕ pending: The posts has not yet been processed. Typically a scheduled post.

⮕ success: The post was successfully sent to all social networks.

Path Parameters

Name

Type

Description

Headers

Name

Type

Description

[
    {
        "tier": "business",
        "status": "success",
        "mediaUrls": [
            "https://img.ayrshare.com/012/gb.jpg"
        ],
        "postIds": [
            {
                "platform": "facebook",
                "postUrl": "https://www.facebook.com/1105775157895689_361710168628052",
                "status": "success",
                "id": "105775157895689_361710168628052" // Facebook Social ID
            }
        ],
        "id": "TBEEAqAMMJoweA8wKHUp",
        "errors": [],
        "platforms": [
            "facebook"
        ],
        "scheduleDate": "2020-11-05T12:21:29Z",
        "created": "2022-05-20T17:25:06Z",
        "shortenLinks": true,
        "post": "Today is a great day",
        "type": "scheduled"
    }
]

{
    "action": "history",
    "status": "error",
    "code": 221,
    "message": "History not found.",
    "id": "4W3f3RPr6QSrw8S5Yo8"
}

Please see the /history endpoint for retrieving all posts, including post not sent via Ayrshare.

Request Examples

curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://app.ayrshare.com/api/post/TBEAAqAMMJoweA9wKHUl

const API_KEY = "API_KEY";
fetch("https://app.ayrshare.com/api/post/TBEAAqAMMJoweA9wKHUl", {
      method: "GET",
      headers: {
        "Authorization": `Bearer ${API_KEY}`
      }
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

import requests

headers = {'Authorization': 'Bearer API_KEY'}

r = requests.get('https://app.ayrshare.com/api/post/TBEAAqAMMJoweA9wKHUl', headers=headers)
    
print(r.json())

<?php

// URL and authorization details
$url = 'https://app.ayrshare.com/api/history/TBEAAqAMMJoweA9wKHUl';
$apiKey = 'API_KEY';  // Replace 'API_KEY' with your actual API key

// Initialize a cURL session
$curl = curl_init();

// Set cURL options
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json',
    'Authorization: Bearer ' . $apiKey
));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

// Execute cURL session and get the response
$response = curl_exec($curl);

// Check if any error occurred
if(curl_errno($curl)){
    echo 'Curl error: ' . curl_error($curl);
} else {
    // Decode and re-encode the JSON response to pretty print
    echo json_encode(json_decode($response), JSON_PRETTY_PRINT);
}

// Close cURL session
curl_close($curl);

using System;
using System.Net;
using System.IO;

namespace HistoryGETRequest_charp
{
    class History
    {
        static void Main(string[] args)
        {
            string API_KEY = "API_KEY";
            string url = "https://app.ayrshare.com/api/history/TBEAAqAMMJoweA9wKHUl";

            var httpWebRequest = WebRequest.CreateHttp(url);
            httpWebRequest.ContentType = "application/json";
            httpWebRequest.Headers.Add("Authorization", "Bearer " + API_KEY);

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}

Get a User Profile Post

Get a post for a particular user profile by passing the profileKey parameter as a query parameter.

Available for Business Plans.

cURL example:

curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://app.ayrshare.com/api/history/9dJk82s901X?profileKey=ldfnk0s82j-Hjdkws-jksjwa8-j2jksd

DELETE Delete a Post

DELETE https://app.ayrshare.com/api/post

Delete published posts or scheduled posts. Takes a post id returned from the /post. Note, Instagram, Facebook Groups, and TikTok do not support delete.

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "twitter": {
        "action": "delete",
        "status": "success",
        "id": "1288900099663775749" // Twitter Social ID
    },
    "facebook": {
        "action": "delete",
        "status": "success",
        "id": "104920007983682_108683297607743" // Facebook Social ID
    },
    "status": "success"
}

{
    "action": "delete",
    "status": "error",
    "code": 114,
    "message": "Delete id not found.",
    "id": "IdpUOyihLEpIx0d0N9mI" // Ayrshare Post ID used for delete, comment, analytics, etc.
}

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

$apiUrl = 'https://app.ayrshare.com/api/post';
$apiKey = 'API_KEY';  // Replace 'API_KEY' with your actual API key
$postId = '7NFVK0QIXET5rCUS9tmf'; // Replace with your actual post ID

$headers = [
    'Content-Type: application/json',
    'Authorization: Bearer ' . $apiKey,
];

$data = json_encode(['id' => $postId]);

$curl = curl_init($apiUrl);
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => $data
]);

$response = curl_exec($curl);

if ($response === false) {
    echo 'Curl error: ' . curl_error($curl);
} else {
    echo json_encode(json_decode($response), JSON_PRETTY_PRINT);
}

curl_close($curl);

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);
            }
        }
    }
}

Instagram and Facebook Groups do not support delete via an API. Please go to instagram.com or facebook.com to delete the posts.

Delete User Profile Posts

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

Available for Business Plans.

Node.js example:

const API_KEY = "API_KEY";
const PROFILE_KEY = "PROFILE_KEY";
const id = "Post ID"; // Ayrshare Post ID used for delete, comment, analytics, etc.

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

PUT Update a Post

PUT https://app.ayrshare.com/api/post

Update the scheduleDate of a post, approval status of a post, notes, or visibility of a posted YouTube video.

⮕ The post must have originally have a scheduleDate and be in a "pending" status. The status can be checked with the /history or GET /post endpoints.

⮕ The YouTube video must have been successfully posted to change visibility.

⮕ The approval workflow requires the current status of the post be in "awaiting approval".

If other parameters need to be updated, delete the post and repost.

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "status": "success",
    "id": "ZSU1tnnuykDy25wA6kvX", // Ayrshare Post ID
    "scheduleDate": "2025-07-08T12:30:00Z"
}

{
    "action": "update",
    "status": "error",
    "code": 305,
    "message": "Error updating post. Post ID not found."
}on

{
    "action": "post",
    "status": "error",
    "code": 104,
    "message": "Invalid schedule date format for scheduleDate. https://docs.ayrshare.com/rest-api/endpoints/post#send-a-post"
}

Request Examples

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"id": "s8k2jsk0pl", "scheduleDate": "2023-07-08T12:30:00Z"}' \
-X PUT https://app.ayrshare.com/api/post

const API_KEY = "API_KEY";

fetch("https://app.ayrshare.com/api/post", {
      method: "PUT",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({
        id: "s8k2jsk0pl", // required
        scheduleDate: "2023-07-08T12:30:00Z"]
      }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

import requests

payload = {'id': 's8k2jsk0pl', 
        'scheduleDate': '2023-07-08T12:30:00Z'}
headers = {'Content-Type': 'application/json', 
        'Authorization': 'Bearer API_KEY'}

r = requests.put('https://app.ayrshare.com/api/post', 
    json=payload, 
    headers=headers)
    
print(r.json())

<?php

$apiUrl = 'https://app.ayrshare.com/api/post';
$apiKey = 'API_KEY';  // Replace 'API_KEY' with your actual API key

$headers = [
    'Content-Type: application/json',
    'Authorization: Bearer ' . $apiKey,
];

$data = json_encode([
    'id' => 's8k2jsk0pl',  // Replace with your actual post ID
    'scheduleDate' => '2023-07-08T12:30:00Z'
]);

$curl = curl_init($apiUrl);
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => $data
]);

$response = curl_exec($curl);

if ($response === false) {
    echo 'Curl error: ' . curl_error($curl);
} else {
    echo json_encode(json_decode($response), JSON_PRETTY_PRINT);
}

curl_close($curl);

package main

import (
	"bytes"
	"encoding/json"
	"log"
	"net/http"
)

func main() {
	message := map[string]interface{}{
		"id": "s8k2jsk0pl",
		"scheduleDate": "2023-07-08T12:30:00Z"
	}

	bytesRepresentation, err := json.Marshal(message)
	if err != nil {
		log.Fatalln(err)
	}

	req, _ := http.NewRequest("PUT", "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 = "PUT";
            httpWebRequest.Headers.Add("Authorization", "Bearer " + API_KEY);

            using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
            {
                string json = "{\"id\" : \"s8k2jsk0pl\","
                    + "\"scheduleDate\" : \"2023-07-08T12:30:00Z\",";

                streamWriter.Write(json);
                streamWriter.Flush();
            }

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}#

Update a User Profile Post

Update a post for a particular user profile by passing the profileKey parameter as a body parameter.

Available for Business Plans.

cURL example:

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"id": "s8k2jsk0pl", "scheduleDate": "2023-07-08T12:30:00Z", "profileKey": "6EAL0QQ-JGMMFE7-GJ1CHNQ-7L7ESA0"}' \
-X PUT https://app.ayrshare.com/api/post

PUT Retry a Post

PUT https://app.ayrshare.com/api/post/retry

Retry to publish a post that failed with a status of "error". A retried post will be treated as a scheduled post, thus the final status can be obtained via the /history endpoint or the scheduled action webhook.

While the post is being retried, the status will be "pending". You may check on the status of the retry by calling the GET post endpoint.

The post can only be retried only once. Recommend to only use if the error message indicates a retry is possible.

Available for Premium or Business Plan user only.

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "status": "pending", // The post will be retried
    "id": "N7kaDiZAfwc544OBKlgc" // Ayrshare Post ID
}

{
    "action": "post",
    "status": "error",
    "code": 329,
    "message": "This post was already retired and cannot be retired again."
}

Request Examples

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"id": "s8k2jsk0pl"}' \
-X PUT https://app.ayrshare.com/api/post/retry

const API_KEY = "API_KEY";

fetch("https://app.ayrshare.com/api/post/retry", {
      method: "PUT",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({
        id: "s8k2jsk0pl", // required
      }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

import requests

payload = {'id': 's8k2jsk0pl'}
headers = {'Content-Type': 'application/json', 
        'Authorization': 'Bearer API_KEY'}

r = requests.put('https://app.ayrshare.com/api/post/retry', 
    json=payload, 
    headers=headers)
    
print(r.json())pyth

<?php

$apiUrl = 'https://app.ayrshare.com/api/post/retry';
$apiKey = 'API_KEY';  // Replace 'API_KEY' with your actual API key

$headers = [
    'Content-Type: application/json',
    'Authorization: Bearer ' . $apiKey,
];

$data = json_encode([
    'id' => 's8k2jsk0pl'  // Replace with your actual ID
]);

$curl = curl_init($apiUrl);
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => $data
]);

$response = curl_exec($curl);

if ($response === false) {
    echo 'Curl error: ' . curl_error($curl);
} else {
    echo json_encode(json_decode($response), JSON_PRETTY_PRINT);
}

curl_close($curl);

package main

import (
	"bytes"
	"encoding/json"
	"log"
	"net/http"
)

func main() {
	message := map[string]interface{}{
		"id": "s8k2jsk0pl"
	}

	bytesRepresentation, err := json.Marshal(message)
	if err != nil {
		log.Fatalln(err)
	}

	req, _ := http.NewRequest("PUT", "https://app.ayrshare.com/api/post/retry",
		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()
}

POST Bulk Post

POST https://app.ayrshare.com/api/post/bulk

Bulk schedule posts with CSV (Comma Separated Values) file of posts data. Content-Type must be multipart/form-data.

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "status": "success",
    "posts": [
        {
            "status": "scheduled",
            "scheduleDate": "4/6/21 12:50",
            "id": "X3uTExuEJhyM3u8wCRsA",
            "post": "A great post"
        },
        {
            "status": "scheduled",
            "scheduleDate": "4/6/21 13:00",
            "id": "8RGrekuxMnVa7lVnARFm",
            "post": "An even better postt"
        }
    ]
}

Request Examples

A multipart form-data containing a CSV file of posts will schedule them for a future date.

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: multipart/form-data' \
-F 'file=@"./Ayrshare CSV Template.csv"' \
-X POST https://app.ayrshare.com/api/post/bulk

The CSV file contains the following fields (template below) and are required:

post: The post text.
platforms: Comma separated list of platforms, e.g. "twitter, facebook, instagram".
mediaUrls: URL of media, such as an image or video to include in the post.
scheduleDate: Datetime to schedule the post in UTC format. For example, use format "YYYY-MM-DDThh:mm:ssZ" and send as "2023-07-08T12:30:00Z". Please see https://www.utctime.net/ for examples.

Don't send duplicate posts less than three days apart.

If the scheduleDate of two posts with the exact same text are less than three days apart, the second post will be rejected when the scheduleDate occurs. This is done to protect your account at the networks; they often suspend or shadow-ban accounts with frequent duplicate posts.

CSV Template

Download the template and save as a .csv file.

188B

Ayrshare CSV Template.csv

Previousmedia NextSocial Networks

Last updated 4 hours ago

POST Send a Post

Headers

Request Body

Request Examples

Details on Specific Social Networks

Profile Keys

Image and Video Requirements

Larger Videos

Video Extension

Image or Video Only

Schedule Posts

Auto Hashtags

Approval Workflow

Unsplash

Auto add Unsplash Image Parameters

Shorten Links

Idempotent Posts

Advertising

Use Pre-Set Campaign and Group Ids

Additional Info

Line Breaks

Rich Text Posts

HTML Elements

Additional CSS Codes

Testing Images and Videos

GET Retrieve a Post

Path Parameters

Headers

Request Examples

Get a User Profile Post

DELETE Delete a Post

Headers

Request Body

Request Examples

Delete User Profile Posts

PUT Update a Post

Headers

Request Body

Request Examples

Update a User Profile Post

PUT Retry a Post

Headers

Request Body

Request Examples

POST Bulk Post

Headers

Request Body

Request Examples

CSV Template