Skip to main content
PATCH
/
brands
/
{brand_id}
/
galleries
/
{gallery_id}
Update a gallery
curl --request PATCH \
  --url https://library-backend.dashsocial.com/brands/{brand_id}/galleries/{gallery_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": null,
  "name": "<string>",
  "settings": {},
  "spirit_gallery_enabled": 123,
  "tags": [
    "<string>"
  ]
}
'
{
  "brand_id": 123,
  "name": "<string>",
  "additional_stats": {},
  "created_at": "2023-11-07T05:31:56Z",
  "custom_content": {
    "banner": {
      "brand_media_type": "<string>",
      "can_publish_within": {
        "end": "<string>",
        "start": "<string>"
      },
      "clicks": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "id": 123,
      "media": {
        "source_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "duration": "<unknown>",
        "frame_rate": "<unknown>",
        "id": 123,
        "image_sizes": "<unknown>",
        "media_group": 123,
        "notes": "<string>",
        "original_height": 123,
        "original_width": 123,
        "predictions": "<unknown>",
        "source_created_at": "2026-04-10T14:57:59.977494",
        "source_data": "<unknown>",
        "tags": [
          {
            "brand_id": 123,
            "name": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "id": 123,
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "type": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "urls": "<unknown>",
        "video_sizes": "<unknown>"
      },
      "order": 123,
      "products": [
        {
          "archived": true,
          "clicks": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "id": 123,
          "image_url": "<string>",
          "product_groups": [
            {
              "country_code": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "image_url": "<string>",
              "source_id": "<string>",
              "title": "<string>",
              "url": "<string>"
            }
          ],
          "product_overrides": [
            {
              "brand_id": 123,
              "override": "<string>",
              "source_id": "<string>",
              "availability": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "currency_code": "<string>",
              "description": "<string>",
              "id": 123,
              "image_url": "<string>",
              "last_updated_by_product_feed_at": "2023-11-07T05:31:56Z",
              "original_url": "<string>",
              "price": "<string>",
              "title": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "url": "<string>"
            }
          ],
          "source_id": "<string>",
          "title": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "url": "<string>",
          "x": 123,
          "y": 123
        }
      ],
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "pinned": [
      {
        "brand_media_type": "<string>",
        "can_publish_within": {
          "end": "<string>",
          "start": "<string>"
        },
        "clicks": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "id": 123,
        "media": {
          "source_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "duration": "<unknown>",
          "frame_rate": "<unknown>",
          "id": 123,
          "image_sizes": "<unknown>",
          "media_group": 123,
          "notes": "<string>",
          "original_height": 123,
          "original_width": 123,
          "predictions": "<unknown>",
          "source_created_at": "2026-04-10T14:57:59.977494",
          "source_data": "<unknown>",
          "tags": [
            {
              "brand_id": 123,
              "name": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "id": 123,
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ],
          "type": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "urls": "<unknown>",
          "video_sizes": "<unknown>"
        },
        "order": 123,
        "products": [
          {
            "archived": true,
            "clicks": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "id": 123,
            "image_url": "<string>",
            "product_groups": [
              {
                "country_code": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "description": "<string>",
                "image_url": "<string>",
                "source_id": "<string>",
                "title": "<string>",
                "url": "<string>"
              }
            ],
            "product_overrides": [
              {
                "brand_id": 123,
                "override": "<string>",
                "source_id": "<string>",
                "availability": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "currency_code": "<string>",
                "description": "<string>",
                "id": 123,
                "image_url": "<string>",
                "last_updated_by_product_feed_at": "2023-11-07T05:31:56Z",
                "original_url": "<string>",
                "price": "<string>",
                "title": "<string>",
                "updated_at": "2023-11-07T05:31:56Z",
                "url": "<string>"
              }
            ],
            "source_id": "<string>",
            "title": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "url": "<string>",
            "x": 123,
            "y": 123
          }
        ],
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "description": "<string>",
  "extra_csv_data": null,
  "fb_avg_effectiveness": 123,
  "fb_avg_engagement_rate": 123,
  "fb_avg_paid_and_organic_effectiveness_v2": 123,
  "fb_avg_paid_and_organic_engagement_rate_v2": 123,
  "fb_avg_paid_and_organic_reach_v2": 123,
  "fb_avg_reach": 123,
  "fb_total_engagements": 123,
  "fb_total_impressions": 123,
  "fb_total_paid_and_organic_engagements_v2": 123,
  "fb_total_paid_and_organic_views": 123,
  "gallery_distribution": {
    "competitive_post_count": 123,
    "owned_post_count": 123
  },
  "gallery_size": 123,
  "gallery_stats_updated": "2023-11-07T05:31:56Z",
  "gallery_type": "LIBRARY",
  "id": 123,
  "ig_story_avg_completion_rate": 123,
  "ig_story_avg_completion_rate_views": 123,
  "ig_story_avg_exit_rate": 123,
  "ig_story_avg_exit_rate_views": 123,
  "ig_story_avg_impressions": 123,
  "ig_story_avg_reach": 123,
  "ig_story_avg_views": 123,
  "ig_story_narrative_time_range": {
    "end": "2019-12-01T00:00:00+00:00",
    "start": "2019-12-01T00:00:00+00:00"
  },
  "ig_story_swipe_ups": 123,
  "ig_story_total_impressions": 123,
  "ig_story_total_reach": 123,
  "ig_story_total_replies": 123,
  "ig_story_total_views": 123,
  "instagram_avg_effectiveness": 123,
  "instagram_avg_effectiveness_engagements": 123,
  "instagram_avg_engagement": 123,
  "instagram_avg_reach": 123,
  "instagram_total_comments": 123,
  "instagram_total_likes": 123,
  "instagram_total_reach": 123,
  "label": "<string>",
  "latest_media": [
    {
      "image_url": "<string>"
    }
  ],
  "latest_media_published_at": "2023-11-07T05:31:56Z",
  "library_total_clicks": 123,
  "library_total_high_performing_photos": 123,
  "library_total_low_performing_photos": 123,
  "library_total_top_performing_photos": 123,
  "library_total_views": 123,
  "linkedin_avg_click_through_rate": 123,
  "linkedin_avg_engagement_rate": 123,
  "linkedin_avg_unique_impressions": 123,
  "linkedin_total_impressions": 123,
  "linkedin_total_likes": 123,
  "live": 123,
  "pinterest_avg_engagement_rate": 123,
  "pinterest_total_clicks": 123,
  "pinterest_total_closeups": 123,
  "pinterest_total_comments": 123,
  "pinterest_total_impressions": 123,
  "pinterest_total_saves": 123,
  "pinterest_total_video_views": 123,
  "pinterest_total_visits": 123,
  "settings": {},
  "snapchat_avg_engagement_rate": 123,
  "snapchat_avg_view_time": 123,
  "snapchat_total_engagements": 123,
  "snapchat_total_viewers": 123,
  "snapchat_total_views": 123,
  "spirit_gallery_enabled": 123,
  "tags": [
    {
      "color": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "id": 123,
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "threads_avg_engagement_rate": 123,
  "threads_total_engagements": 123,
  "threads_total_likes": 123,
  "threads_total_replies": 123,
  "threads_total_views": 123,
  "tiktok_avg_engagement_rate": 123,
  "tiktok_avg_retention_rate": 123,
  "tiktok_avg_video_views": 123,
  "tiktok_total_reach": 123,
  "tiktok_total_video_views": 123,
  "twitter_avg_engagement_rate": 123,
  "twitter_impressions": 123,
  "twitter_likes": 123,
  "twitter_retweets": 123,
  "twitter_total_engagements": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "youtube_avg_view_duration": 123,
  "youtube_subscribers": 123,
  "youtube_total_engagements": 123,
  "youtube_total_video_views": 123,
  "youtube_total_watch_time": 123
}

Documentation Index

Fetch the complete documentation index at: https://developer.dashsocial.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer<int32>
required

The Dash Social assigned ID of the brand.

The ID of the gallery object.

Required range: x >= 0

Body

application/json
description
string | null

Description of the gallery.

name
string

Name of the gallery.

settings
object

Gallery settings.

Is Spirit Gallery enabled for this gallery?

tags
string[]

List of tags for Gallery.

Response

OK

brand_id
integer
required
name
string
required
Maximum string length: 256
additional_stats
object
read-only
created_at
string<date-time>
custom_content
object

Custom Gallery content such as banner or pinned media

description
string | null
Maximum string length: 2000
extra_csv_data
unknown
fb_avg_effectiveness
number | null
fb_avg_engagement_rate
number | null
fb_avg_paid_and_organic_effectiveness_v2
number | null
fb_avg_paid_and_organic_engagement_rate_v2
number | null
fb_avg_paid_and_organic_reach_v2
number | null
fb_avg_reach
number | null
fb_total_engagements
integer | null
fb_total_impressions
integer | null
fb_total_paid_and_organic_engagements_v2
integer | null
fb_total_paid_and_organic_views
integer | null

Type of gallery.

Available options:
instagram,
INSTAGRAM,
instagram_likeshop,
INSTAGRAM_LIKESHOP,
pinterest,
PINTEREST,
library,
LIBRARY,
instagram_story,
INSTAGRAM_STORY,
instagram_story_narrative,
INSTAGRAM_STORY_NARRATIVE,
tiktok,
TIKTOK,
tiktok_likeshop,
TIKTOK_LIKESHOP,
facebook,
FACEBOOK,
twitter,
TWITTER,
youtube,
YOUTUBE,
linkedin,
LINKEDIN,
threads,
THREADS,
snapchat,
SNAPCHAT
id
integer
ig_story_avg_completion_rate
number
read-only
ig_story_avg_completion_rate_views
number
read-only
ig_story_avg_exit_rate
number | null
ig_story_avg_exit_rate_views
number | null
ig_story_avg_impressions
number
read-only
ig_story_avg_reach
number
read-only
ig_story_avg_views
number
read-only
ig_story_narrative_time_range
object
ig_story_swipe_ups
integer
read-only
ig_story_total_impressions
integer | null
ig_story_total_reach
integer | null
ig_story_total_replies
integer | null
ig_story_total_views
integer | null
instagram_avg_effectiveness
number | null
instagram_avg_effectiveness_engagements
number | null
instagram_avg_engagement
number | null
instagram_avg_reach
integer | null
instagram_total_comments
integer | null
instagram_total_likes
integer | null
instagram_total_reach
integer | null
label
string
Maximum string length: 256
latest_media
object[]
latest_media_published_at
string<date-time> | null
library_total_clicks
integer | null
library_total_high_performing_photos
integer | null
library_total_low_performing_photos
integer | null
library_total_top_performing_photos
integer | null
library_total_views
integer | null
linkedin_avg_click_through_rate
number | null
linkedin_avg_engagement_rate
number | null
linkedin_avg_unique_impressions
number | null
linkedin_total_impressions
integer | null
linkedin_total_likes
integer | null
live
integer | null
pinterest_avg_engagement_rate
number | null
pinterest_total_clicks
integer | null
pinterest_total_closeups
integer | null
pinterest_total_comments
integer | null
pinterest_total_impressions
integer | null
pinterest_total_saves
integer | null
pinterest_total_video_views
integer | null
pinterest_total_visits
integer | null
settings
object
snapchat_avg_engagement_rate
number | null
snapchat_avg_view_time
number | null
snapchat_total_engagements
integer | null
snapchat_total_viewers
integer | null
snapchat_total_views
integer | null
tags
object[]

List of gallery tags.

threads_avg_engagement_rate
number | null
threads_total_engagements
integer | null
threads_total_likes
integer | null
threads_total_replies
integer | null
threads_total_views
integer | null
tiktok_avg_engagement_rate
number | null
tiktok_avg_retention_rate
number | null
tiktok_avg_video_views
number | null
tiktok_total_reach
integer | null
tiktok_total_video_views
integer | null
twitter_avg_engagement_rate
number | null
twitter_impressions
integer | null
twitter_likes
integer | null
twitter_retweets
integer | null
twitter_total_engagements
integer | null
updated_at
string<date-time>
youtube_avg_view_duration
number | null
youtube_subscribers
integer | null
youtube_total_engagements
integer | null
youtube_total_video_views
integer | null
youtube_total_watch_time
integer | null