profiles

Ayrshare Home Login Business Plan Chat with Us
Search…
profiles
Profiles API Endpoint: Create and manage multiple profile accounts. If you require multiple account for your business or users, please contact us at [email protected] for assistance.
User Profile API Endpoint
❗Click the › in the endpoint to view details.
post
https://app.ayrshare.com/api
/post
Post to User Profiles
If a response of an array is required, please include the body parameter arrayResponse with the boolean value of true. 
It is important to follow the rules of the social networks, especially in regards to duplicate or similar content. Please see here for details:
Post Verification
Request Examples
cURL
Node.js
Python
PHP
Go
C#
curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"post": "Today is a great day!", "platforms": ["twitter", "facebook", "instagram", "linkedin"], "profileKeys": ["PROFILE_KEY"], "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";
const postMsg = "Today is a great day!";
​
fetch("https://app.ayrshare.com/api/post", {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({
        post: postMsg, // required
        platforms: ["twitter", "facebook", "instagram", "linkedin"], // required
        profileKeys: ["PROFILE_KEY"],  // required for client posting
        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'],
        'profileKeys': ['PROFILE_KEY'],
        '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 using Guzzle. See https://docs.guzzlephp.org/en/stable/overview.html
​
$client = new GuzzleHttp\Client();
$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!',
            'platforms' => ['twitter', 'facebook', 'instagram', 'linkedin'], // required
            'profileKeys' => ['PROFILE_KEY'], // 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"},
		"profileKeys": []string{"PROFILE_KEY"},
		"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 forever!\","
                    + "\"platforms\" : [ \"twitter\", \"facebook\", \"instagram\", \"linkedin\" ]," 
                    + "\"mediaUrls\" : [ \"https://images.ayrshare.com/imgs/GhostBusters.jpg\" ],"
                    + "\"profileKeys\" : [ \"PROFILE_KEY\" ]}";
​
                streamWriter.Write(json);
                streamWriter.Flush();
            }
​
            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}
​
post
https://app.ayrshare.com/api
/profiles/profile
Create a User Profile
Request Examples
cURL
Node.js
Python
PHP
Go
C#
curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"title": "ACME Profile"}' \
-X POST https://app.ayrshare.com/api/profiles/profile
const fetch = require("node-fetch");
const API_KEY = "API_KEY";
​
fetch("https://app.ayrshare.com/api/profiles/profile", {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({
        title: "ACME Profile", // required
      }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);
import requests
​
payload = {'title': 'ACME Profile'}
headers = {'Content-Type': 'application/json', 
        'Authorization': 'Bearer API_KEY'}
​
r = requests.post('https://app.ayrshare.com/api/profiles/profile', 
    json=payload, 
    headers=headers)
    
print(r.json())
<?php
require 'vendor/autoload.php';    // Composer auto-loader using Guzzle. See https://docs.guzzlephp.org/en/stable/overview.html
​
$client = new GuzzleHttp\Client();
$res = $client->request(
    'POST',
    'https://app.ayrshare.com/api/profiles/profile',
    [
        'headers' => [
            'Content-Type'      => 'application/json',
            'Authorization'     => 'Bearer API_KEY'
        ],
        'title' => ['ACME Profile'],
    ]
);
​
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{}{
		"title": "ACME Profile"
	}
​
	bytesRepresentation, err := json.Marshal(message)
	if err != nil {
		log.Fatalln(err)
	}
​
	req, _ := http.NewRequest("POST", "https://app.ayrshare.com/api/profiles/profile",
		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 CreateProfilePOSTRequest_charp
{
    class CreateProfile
    {
        static void Main(string[] args)
        {
            string API_KEY = "API_KEY";
            string url = "https://app.ayrshare.com/api/profiles/profile";
​
            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 = "{\"title\" : \"ACME Profile\"}";
​
                streamWriter.Write(json);
                streamWriter.Flush();
            }
​
            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}
The Profile Key should be securely stored in your system with appropriate access controls. The refId should  be stored to associate a profile to an endpoint return.
​
delete
https://app.ayrshare.com/api
/profiles/profile
Delete a User Profile
Request Examples
cURL
Node.js
Python
PHP
C#
curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"profileKey": "PROFILE_KEY"}' \
-X DELETE https://app.ayrshare.com/api/profiles/profile
const fetch = require("node-fetch");
const API_KEY = "API_KEY";
const profileKey = "PROFILE_KEY";
​
fetch("https://app.ayrshare.com/api/profiles/profile", {
      method: "DELETE",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({ profileKey }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);
import requests
​
payload = {'profileKey': 'PROFILE_KEY'}
headers = {'Content-Type': 'application/json', 
        'Authorization': 'Bearer API_KEY'}
​
r = requests.delete('https://app.ayrshare.com/api/profiles/profile', 
    json=payload, 
    headers=headers)
    
print(r.json())
<?php
require 'vendor/autoload.php';    // Composer auto-loader using Guzzle. See https://docs.guzzlephp.org/en/stable/overview.html
​
$client = new GuzzleHttp\Client();
$res = $client->request(
    'DELETE',
    'https://app.ayrshare.com/api/profiles/profile',
    [
        'headers' => [
            'Content-Type'      => 'application/json',
            'Authorization'     => 'Bearer API_KEY'
        ],
        'profileKey' => ['PROFILE_KEY'],
    ]
);
​
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/profiles/profile";
​
            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 = "{\"profileKey\" : \"Profile Key\"}";
​
                streamWriter.Write(json);
                streamWriter.Flush();
            }
​
            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}
​
put
https://app.ayrshare.com/api
/profiles/profile
Update a User Profile
Request Examples
cURL
Node.js
Python
PHP
C#
curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"profileKey": "Jokdf-903Js-j9sd0-Pow02-QS9n3", "title": "ACME Profile"}' \
-X PUT https://app.ayrshare.com/api/profiles/profile
const fetch = require("node-fetch");
const API_KEY = "API_KEY";
​
fetch("https://app.ayrshare.com/api/profiles/profile", {
      method: "PUT",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({
        profileKey: "Jokdf-903Js-j9sd0-Pow02-QS9n3", // required
        title: "ACME Profile",
      }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);
import requests
​
payload = {'profileKey': 'Jokdf-903Js-j9sd0-Pow02-QS9n3', 'title': 'ACME Profile'}
headers = {'Content-Type': 'application/json', 
        'Authorization': 'Bearer API_KEY'}
​
r = requests.put('https://app.ayrshare.com/api/profiles/profile', 
    json=payload, 
    headers=headers)
    
print(r.json())
<?php
require 'vendor/autoload.php';    // Composer auto-loader using Guzzle. See https://docs.guzzlephp.org/en/stable/overview.html
​
$client = new GuzzleHttp\Client();
$res = $client->request(
    'PUT',
    'https://app.ayrshare.com/api/profiles/profile',
    [
        'headers' => [
            'Content-Type'      => 'application/json',
            'Authorization'     => 'Bearer API_KEY'
        ],
        'profileKey'    => ['Jokdf-903Js-j9sd0-Pow02-QS9n3'],
        'title'         => ['ACME Profile'],
    ]
);
​
echo json_encode(json_decode($res->getBody()), JSON_PRETTY_PRINT);
using System;
using System.Net;
using System.IO;
​
namespace CreateProfilePOSTRequest_charp
{
    class CreateProfile
    {
        static void Main(string[] args)
        {
            string API_KEY = "API_KEY";
            string url = "https://app.ayrshare.com/api/profiles/profile";
​
            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 = "{\"profileKey\" : \"Jokdf-903Js-j9sd0-Pow02-QS9n3\", \"title\" : \"ACME Profile\"}";
​
                streamWriter.Write(json);
                streamWriter.Flush();
            }
​
            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}
​
get
https://app.ayrshare.com/api
/profiles
Get User Profiles
Request Examples
cURL
Node.js
Python
PHP
C#
curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://app.ayrshare.com/api/profiles
const fetch = require("node-fetch");
const API_KEY = "API_KEY";
​
fetch("https://app.ayrshare.com/api/profiles", {
      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/profiles', headers=headers)
    
print(r.json())
<?php
require 'vendor/autoload.php';    // Composer auto-loader using Guzzle. See https://docs.guzzlephp.org/en/stable/overview.html
​
$client = new GuzzleHttp\Client();
$res = $client->request(
    'GET',
    'https://app.ayrshare.com/api/profiles',
    [
        'headers' => [
            'Content-Type'      => 'application/json',
            'Authorization'     => 'Bearer API_KEY'
        ]
    ]
);
​
echo json_encode(json_decode($res->getBody()), JSON_PRETTY_PRINT); 
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/profiles";
​
            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);
            }
        }
    }
}
​
delete
https//app.ayrshare.com/api/profiles
/social
Unlink a Social Network
Request Examples
cURL
Node.js
Python
PHP
C#
curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"platform": "twitter"}' \
-d '{"profileKey": "PROFILE_KEY"}' \
-X DELETE https://app.ayrshare.com/api/profiles/social
const fetch = require("node-fetch");
const API_KEY = "API_KEY";
const profileKey = "PROFILE_KEY";
​
fetch("https://app.ayrshare.com/api/profiles/social", {
      method: "DELETE",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({ platform: "twitter", profileKey }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);
import requests
​
payload = {'platform': 'twitter', 'profileKey': 'PROFILE_KEY'}
headers = {'Content-Type': 'application/json', 
        'Authorization': 'Bearer API_KEY'}
​
r = requests.delete('https://app.ayrshare.com/api/profiles/social', 
    json=payload, 
    headers=headers)
    
print(r.json())
<?php
require 'vendor/autoload.php';    // Composer auto-loader using Guzzle. See https://docs.guzzlephp.org/en/stable/overview.html
​
$client = new GuzzleHttp\Client();
$res = $client->request(
    'DELETE',
    'https://app.ayrshare.com/api/profiles/social',
    [
        'headers' => [
            'Content-Type'      => 'application/json',
            'Authorization'     => 'Bearer API_KEY'
        ],
        'platform' => 'twitter',
        'profileKey' => ['PROFILE_KEY'],
    ]
);
​
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/profiles/social";
​
            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 = "{\"platform\" : \"twitter\", \"profileKey\" : \"Profile Key\"}";
​
                streamWriter.Write(json);
                streamWriter.Flush();
            }
​
            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}
​
post
https://app.ayrshare.com/api
/profiles/generateJWT
Generate a JWT
Request Examples
cURL
Node.js
Python
PHP
C#
curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"domain": "ACME", "privateKey": "-----BEGIN RSA PRIVATE KEY...", "profileKey": "PROFILE_KEY"}' \
-X POST https://app.ayrshare.com/api/profiles/generateJWT
const fetch = require("node-fetch");
const fs = require('fs');
const API_KEY = "API_KEY";
const PROFILE_KEY = "PROFILE_KEY";
​
// Read in local private.key files - also can read from a DB
const privateKey = fs.readFileSync('private.key', 'utf8');
​
fetch("https://app.ayrshare.com/api/profiles/generateJWT", {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({
        domain: "ACME",          // required
        privateKey,              // required
        profileKey: PROFILE_KEY, // required
      }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);
import requests
​
# Read in local private.key files - also can read from a DB
with open('.private.key') as f:
    profileKey = f.read()
​
payload = {'domain': 'ACME', 
        'privateKey': profileKey,
        'profileKey': 'PROFILE_KEY' }
headers = {'Content-Type': 'application/json', 
        'Authorization': 'Bearer API_KEY'}
​
r = requests.post('https://app.ayrshare.com/api/profiles/generateJWT', 
    json=payload, 
    headers=headers)
    
print(r.json())
<?php
require 'vendor/autoload.php';    // Composer auto-loader using Guzzle. See https://docs.guzzlephp.org/en/stable/overview.html
​
$client = new GuzzleHttp\Client();
$res = $client->request(
    'POST',
    'https://app.ayrshare.com/api/post',
    [
        'headers' => [
            'Content-Type'  => 'application/json',
            'Authorization' => 'Bearer API_KEY'
        ],
        'json' => [
            'domain' => 'ACME',
            'privateKey' => '-----BEGIN RSA PRIVATE KEY...', // required
            'profileKey' => 'PROFILE_KEY', // requires
        ]
    ]
);
​
echo json_encode(json_decode($res->getBody()), JSON_PRETTY_PRINT);
using System;
using System.Net;
using System.IO;
​
namespace GenerateJWTRequest_charp
{
    class GenerateJWT
    {
        static void Main(string[] args)
        {
            string API_KEY = "API_KEY";
            string url = "https://app.ayrshare.com/api/profiles/generateJWT";
​
            var httpWebRequest = WebRequest.CreateHttp(url);
            httpWebRequest.ContentType = "application/json";
            httpWebRequest.Method = "POST";
            httpWebRequest.Headers.Add("Authorization", "Bearer " + API_KEY);
​
            string privateKey = File.ReadAllText("./private.key");  // Provide with integration guide
            using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
            {
                var sendData = new
                {
                    domain = "domain",            // Provide in integration guide
                    privateKey = privateKey,
                    profileKey = "PROFILE_KEY"
                };
​
                // Install Newtonsoft.Json with NuGet or another JSOON serializer
                string jsonData = Newtonsoft.Json.JsonConvert.SerializeObject(sendData);
                streamWriter.Write(jsonData);
                streamWriter.Flush();
            }
​
            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}
If you want to switch profile sessions, i.e. use a different profile, please see Automatic Logout of a Profile Session.
The Private Key must be precise, meaning preserving all characters including newlines. We recommend reading the private.key from a file to preserve all characters. If you paste the key into your code, you might need to manually replace newlines with a \n character or URL encode the string.
Pasting the key directly into code often gives issues.
It is recommend to first verify your data in Postman using generateJWT. You can then generate the code from Postman, or read the key file from a directory or database.
❗Use the verify field  in the /generateJWT endpoint to check the parameters.
Generate a JSON Web Token
1 minute video explaining how to generate a JSON Web Token (JWT):
Bubble.io
If you are a Bubble user, please see Generate JWT Token in the Bubble.io section for instructions:
Bubble.io
Additional Endpoints
All other endpoints, such as /user, /analytics, or /delete, can be called on behalf of a Profile account by adding the "profileKeys" parameter and sending a single profileKey as a String.
For example, the /delete endpoint can be called to delete a Profile account's post for the given post id for the provided Profile Key.
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/delete", {
      method: "DELETE",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },