Create Share Set - Plugixa Easy Social Share Buttons

POST /plugixa-social-share/v1/sets

Create a share set: a row of buttons with its own networks and look, placed automatically, by hand, or both.

An account with the plugixa_social_share_edit capability. Administrators hold it; no other role does until you grant it.

Request

POST https://your-site.example/wp-json/plugixa-social-share/v1/sets

Request body

Content type: application/json

The instance object

Any other value outside the listed choices falls back to that field’s default instead of failing the request. A network slug the plugin does not know is kept as sent, but draws no button.

The placements object

An object keyed by post type slug (post, page, …), or by _home for the blog home and _archive for archives. List Share Sets returns the keys this site accepts in post_types. Each value is:

A key that is not offered on this site right now is ignored, and an entry that places nothing is dropped. A spot belongs to one set at a time: when this set claims a spot another set holds on the same key, it is taken from that set and reported in moved.

{
  "name": "Footer row",
  "instance": {
    "networks": [
      "facebook",
      "x",
      "copy"
    ],
    "template": "pill",
    "layout": "icon"
  },
  "placements": {
    "post": {
      "content": "content_bottom",
      "extra": []
    }
  }
}

Responses

201 Created. data.item is the new set.

{
  "success": true,
  "data": {
    "item": {
      "id": 2,
      "name": "Footer row",
      "instance": {
        "networks": [
          "facebook",
          "x",
          "copy"
        ],
        "template": "pill",
        "layout": "icon",
        "align": "start",
        "counts": false,
        "total": false,
        "label": "",
        "vertical": false,
        "size": "medium",
        "size_mobile": "inherit",
        "count_pos": "after",
        "total_pos": "after",
        "more": false,
        "color": "",
        "ink": ""
      },
      "placements": {
        "post": {
          "content": "content_bottom",
          "extra": []
        }
      },
      "created": 1794475800,
      "modified": 1794475800,
      "label": "Footer row"
    },
    "moved": [
      {
        "set_id": 1,
        "post_type": "post",
        "slot": "content_bottom",
        "set_label": "Share set 1",
        "post_type_label": "Posts",
        "slot_label": "Below the content"
      }
    ],
    "items": [
      {
        "id": 1,
        "name": "",
        "instance": {
          "networks": [
            "facebook",
            "x",
            "linkedin",
            "whatsapp",
            "email",
            "copy"
          ],
          "template": "default",
          "layout": "full",
          "align": "start",
          "counts": false,
          "total": false,
          "label": "",
          "vertical": false,
          "size": "medium",
          "size_mobile": "inherit",
          "count_pos": "after",
          "total_pos": "after",
          "more": false,
          "color": "",
          "ink": ""
        },
        "placements": {
          "page": {
            "content": "content_bottom",
            "extra": []
          }
        },
        "created": 1793000000,
        "modified": 1794475800,
        "label": "Share set 1"
      },
      {
        "id": 2,
        "name": "Footer row",
        "instance": {
          "networks": [
            "facebook",
            "x",
            "copy"
          ],
          "template": "pill",
          "layout": "icon",
          "align": "start",
          "counts": false,
          "total": false,
          "label": "",
          "vertical": false,
          "size": "medium",
          "size_mobile": "inherit",
          "count_pos": "after",
          "total_pos": "after",
          "more": false,
          "color": "",
          "ink": ""
        },
        "placements": {
          "post": {
            "content": "content_bottom",
            "extra": []
          }
        },
        "created": 1794475800,
        "modified": 1794475800,
        "label": "Footer row"
      }
    ],
    "primary": 1
  }
}

Errors

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-social-share/v1/sets" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"name":"Footer row","instance":{"networks":["facebook","x","copy"],"template":"pill","layout":"icon"},"placements":{"post":{"content":"content_bottom","extra":[]}}}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-social-share/v1/sets');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'name'       => 'Footer row',
        'instance'   => [
            'networks' => ['facebook', 'x', 'copy'],
            'template' => 'pill',
            'layout'   => 'icon',
        ],
        'placements' => [
            'post' => [
                'content' => 'content_bottom',
                'extra'   => [],
            ],
        ],
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-social-share/v1/sets', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Footer row', instance: { networks: ['facebook', 'x', 'copy'], template: 'pill', layout: 'icon' }, placements: { post: { content: 'content_bottom', extra: [] } } }),
});
const { data } = await response.json();