ayrlink

Create an Ayrlink link in bio page for your users on Instagram, TikTok, YouTube, or any social media site.

Ayrlink Link In Bio API Endpoint

Please note this endpoint is in Beta, and is subject to change without prior notice.

A link in bio page is a way for your user to present their social media accounts and other important information in a single web page which is optimized for a mobile phone screen size. Typically, this link is used in the Instagram, TikTok, and YouTube profiles pages and can be used on all social media networks.

A link in bio page is a dedicated webpage that users create to act as a central hub for multiple links they want to share with their followers. Learn more about link in bio pages and why they are great for social.

Your user can create a handle and the bio page will be at www.ayrl.ink/bio/handle. For example, check out the Ayrshare Link In Bio Page.

Each Ayrshare profile can have only one Ayrlink handle and associated bio page.

Enterprise clients should contact support to discuss how to remove the Ayrshare branding on the Ayrlink bio pages.

❗Click the › in the endpoint to view details.

Get the details the Ayrlink page

GET https://app.ayrshare.com/api/ayrlink

Get the details of an existing Ayrlink bio link page.

Headers

Name	Type	Description
Authorization*	string	Format: Authorization: Bearer API_KEY. See Overview for more information.
Profile-Key	string	Profile Key of a user profile.

200: OK Successful Response

{
    "ayrlinkUrl": "https://ayrl.ink/bio/ayrshare",
    "backgroundImage": "https://unsplash.com/photos/rKv4HduvzIE/download?ixid=MnwxMjA3fDB8MXxhbGx8fHx8fHx8fHwxNjY3OTE2Mjky&force=true&w=640",
    "button1Text": "Ayrshare Home Page",
    "button1Url": "https://www.ayrshare.com",
    "button2Text": "Learn About Business Plans",
    "button2Url": "https://www.ayrshare.com/business-plan-for-multiple-users/",
    "button3Text": "Read the API Docs",
    "button3Url": "https://docs.ayrshare.com/",
    "created": "2022-11-08T14:51:23.739Z",
    "handle": "ayrshare",
    "modifiedDate": "2022-11-08T15:08:30.698Z",
    "profileImage": "https://www.ayrshare.com/wp-content/uploads/ayrshare-purple-icon.jpg",
    "socialUrls": {
        "facebook": "https://www.facebook.com/Ayrshare/",
        "instagram": "https://www.instagram.com/ayrshare/",
        "linkedin": "https://www.linkedin.com/company/ayrshare/",
        "twitter": "https://twitter.com/ayrshare",
        "youtube": "https://www.youtube.com/@ayrshare"
    },
    "text1": "Ayrshare is the Social Media API",
    "text2": "The Ayrshare Social API takes care of your social media infrastructure so you don't have to. Your team can focus on building your product instead of stitching together and maintaining multiple social media networks. With a few lines of code, you can start offering your users the ability to post, schedule, and get analytics."
}

400: Bad Request Error with Ayrlink Page

{
    "action": "post",
    "status": "error",
    "code": 321,
    "message": "Error with Ayrlink page. Ayrlink bio link page does not exist for this user."
}

Create an Ayrlink link in bio page

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

Create an Ayrlink bio page for a specific handle.

Any optional parameters that are not set to a value, will cause that items to not be visible. For example, if no socialIconFacebookUrl value is sent, then that icon will not be shown on the Ayrlink bio page. An empty text string will be treated as no value.

Headers

Name	Type	Description
Authorization*	string	Format: Authorization: Bearer API_KEY. See Overview for more information.
Profile-Key	string	Profile Key of a user profile.

Request Body

Name	Type	Description
handle*	string	The handle for the page
profileImage	string	URL for the profile image
backgroundImage	string	URL for the background image
text1	string	The text1 field
text2	string	The text2 field
button1Text	string	Text for button1
button1Url	string	URL for button1
button2Text	string	Text for button2
button2Url	string	URL for button2
button3Text	string	Text for button3
button3Url	string	URL for button3
socialUrls	object	Set the URLs that the social icons link to when clicked. See SocialUrls details.
autoSyncSocialUrls	boolean	If set to true, will auto set all the social URLs based on the social accounts currently linked with Ayrshare. Overrides any settings in socialUrls.

200 Page created successfully

{
    "status": "success",
    "url": "https://ayrl.ink/bio/handle"
}

Update an Ayrlink link in bio page

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

Change any of the parameters for the Ayrlink bio page.

Remember that a handle can be changed. If you change the handle, then the previous handle used will be available for another user to claim.

Headers

Name	Type	Description
Authorization*	string	Format: Authorization: Bearer API_KEY. See Overview for more information.
Profile-Key	string	Profile Key of a user profile.

Request Body

Name	Type	Description
handle	string	The handle for the page
profileImage	string	URL for the profile image
backgroundImage	strin	URL for the background image
text1	string	The text1 field
text2	string	The text2 field
button3Url	string	URL for button3
button3Text	string	Text for button3
button2Url	string	URL for button2
button2Text	string	Text for button2
button1Url	string	URL for button1
button1Text	string	Text for button1
socialUrls	object	Set the URLs that the social icons link to when clicked. See SocialUrls details.
autoSyncSocialUrls	boolean	If set to true, will auto set all the social URLs based on the social accounts currently linked with Ayrshare. Overrides any settings in socialUrls.

200 Successful update

{
    "status": "success",
    "url": "https://ayrl.ink/bio/handle"
}

Delete an Ayrlink handle and associated bio page

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

Delete an the Ayrlink bio page associated with the User Profile. This will allow someone else to claim the handle.

Headers

Name	Type	Description
Authorization*	string	Format: Authorization: Bearer API_KEY. See Overview for more information.
Profile-Key	string	Profile Key of a user profile.

200: OK Successful deletion

{
    "status": "success"
}

Check if an Ayrlink handle is available

GET https://app.ayrshare.com/api/ayrlink/checkHandle

Before creating a new Ayrlink page, check if the handle is available. Include the handle value that you want to check in the URL as a query parameter.

Premium or Business Plan required.

Query Parameters

Name	Type	Description
handle*	string	Ayrlink handle to check if exists.

Headers

Name	Type	Description
Authorization*	string	Format: Authorization: Bearer API_KEY. See Overview for more information.

200 Schedule successfully set.

{
    "status": "success",
    "exists": false        // true if exists, false if doesn't exist
}

Set SocialUrls

Set the URLs that the social icons link to when clicked. The socialUrls field is an object that have the options fields of facebook, github, instagram, linkedin, pinterest, tiktok, twitter, or youtube with the value of the string URL.

{
    "socialUrls": {    // all fields optional
        "facebook": "https://www.facebook.com/ayrshare",
        "github": "https://github.com/ayrshare",
        "instagram": "https://www.instagram.com/ayrshare",
        "linkedin": "https://www.linkedin.com/company/ayrshare",
        "pinterest": "https://www.pinterest.com/ayrshare/",
        "tiktok": "https://tiktok.com/@ayrshare",
        "twitter": "https://twitter.com/ayrshare",
        "youtube": "https://www.youtube.com/@ayrshare"
    }
}

Video Overview

Ayrlink Link In Bio API

Create an Ayrlink Bio Page in the Dashboard

You can also manually create the bio page in the Ayrshare Dashboard by clicking "Ayrlink" on the left column. Just enter your data and see a preview.