v8

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-2526602.8 MB
Settings

Add Social Media Button

Adds a new social media button to the account

post/api/{account}/settings/social-media-buttons

Request body

labelstring required

The button label

type'instagram' | 'x' | 'facebook' | 'youtube' | 'tiktok' | 'snapchat' | 'amazon' | 'twitch' | 'discord' | 'patreon' | 'pinterest' | 'etsy' | 'bereal' | 'kick' | 'depop' | 'poshmark' | 'vsco' | 'threads' | 'throne' | 'shopltk' | 'oftv' | 'bluesky' required

The button type

valuestring required

The button value, either a username or link.

Example request

{
  "label": "Instagram",
  "type": "Instagram",
  "value": "example_user"
}

Response

Example response

{
  "data": [
    {
      "id": 123,
      "sort": 0,
      "label": "Amazon",
      "username": "",
      "socialMedia": "amazon",
      "link": "https://amazon.com/example",
      "url": "https://amazon.com/example",
      "isValid": true,
      "clicks": 0
    }
  ],
  "_meta": {
    "_credits": {
      "used": 1,
      "balance": 999999959,
      "note": "Always"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    },
    "_rate_limits": {
      "limit_minute": 1000,
      "limit_day": 50000,
      "remaining_minute": 999,
      "remaining_day": 49986
    }
  }
}