Back to top

Social Post

Overview

Resource Group

Get Social posts of brand

Get Social posts of brand
GET/brands/:brand/social-posts

brand (uuid) ID of the brand

user (uuid) ID of the user (optional)

status (‘executed’ | ‘scheduled’ | ‘draft’ | ‘any’) string (optional)

start (number) number of rows to skip before starting to return rows

limit (number) limited number of records

video (boolean) if the template was video

mediums (Email’ | ‘Social’ | ‘CrmOpenHouse’ | ‘FacebookCover’ | ‘InstagramStory’ | ‘LinkedInCover’ | ‘Letter’ | ‘Website’ | ‘RealtorCover’ | ‘YouTubeCover’ | ‘TwitterCover’)[] array of medium

order (string) eg: -created_at (optional)

Example URI

GET /brands/:brand/social-posts
URI Parameters
HideShow
brand
string (required) Example: 387ee90b-c91a-40cd-a1c5-f819e9151ac4
status
string (required) Example: executed
associations
string (required) Example: social_post.template_instance,social_post.asset,social_post.owner
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "53d64a2e-0130-4202-a950-c8333b1ad2ff",
      "brand": "387ee90b-c91a-40cd-a1c5-f819e9151ac4",
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "caption": "test",
      "facebook_page": "5c6b715f-4b6e-40db-bd51-9382d7d9e683",
      "template_instance": {
        "id": "992efcfe-718d-49c6-9ad1-57dbcfc56398",
        "created_at": 1774173582.559825,
        "html": "<div>fakeTemplateInstance</div>",
        "file": {
          "id": "aa1b3182-af4e-4351-bf09-332808f8a23e",
          "created_at": 1774173583.657976,
          "updated_at": 1774173583.657976,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "path": "templates/instances/d9bdc370-25d5-11f1-83ca-c9fd0d26db3c.png",
          "name": "image.png",
          "public": true,
          "type": "file",
          "url": "https://test.cloudfront.net/templates/instances/d9bdc370-25d5-11f1-83ca-c9fd0d26db3c.png",
          "preview_url": "https://test.cloudfront.net/templates/instances/d9bdc370-25d5-11f1-83ca-c9fd0d26db3c.png",
          "mime": "image/png"
        },
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "branch": "http://mock-branch-url",
        "updated_at": 1774173582.559825,
        "deleted_at": null,
        "type": "template_instance"
      },
      "asset": null,
      "post_link": "http://test.com",
      "failed_at": null,
      "failure": null,
      "media_container_id": "test",
      "type": "social_post",
      "created_at": 1774173583.748516,
      "updated_at": 1774173583.748516,
      "deleted_at": null,
      "due_at": 1774172983.71,
      "executed_at": 1774173582.559825,
      "owner": {
        "type": "user",
        "username": null,
        "first_name": "Unit",
        "last_name": "Test",
        "email": "[email protected]",
        "phone_number": "+4368120265807",
        "created_at": 1493115498.770362,
        "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "address_id": null,
        "cover_image_url": null,
        "profile_image_url": null,
        "updated_at": 1493115498.770744,
        "user_status": "Active",
        "profile_image_thumbnail_url": null,
        "cover_image_thumbnail_url": null,
        "email_confirmed": true,
        "timezone": "America/Chicago",
        "user_type": "Admin",
        "deleted_at": null,
        "phone_confirmed": false,
        "is_shadow": false,
        "personal_room": null,
        "brand": null,
        "fake_email": false,
        "features": [
          "Deals"
        ],
        "last_seen_at": null,
        "email_signature": null,
        "daily_enabled": false,
        "email_quota": 30000,
        "website": null,
        "instagram": null,
        "twitter": null,
        "linkedin": null,
        "youtube": null,
        "facebook": null,
        "designation": null,
        "tiktok": null,
        "mfa_enabled": false,
        "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "current_time": "4:59 AM - Sunday Mar 22, 2026",
        "push_allowed": false,
        "agents": null,
        "last_seen_type": null,
        "active_brand": "387ee90b-c91a-40cd-a1c5-f819e9151ac4",
        "display_name": "Unit Test",
        "abbreviated_display_name": "Unit",
        "online_state": "Offline",
        "has_password": true
      }
    },
    {
      "id": "7c575539-2681-4dad-9640-75b462d86827",
      "brand": "387ee90b-c91a-40cd-a1c5-f819e9151ac4",
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "caption": "testAsset",
      "facebook_page": "5c6b715f-4b6e-40db-bd51-9382d7d9e683",
      "template_instance": null,
      "asset": {
        "id": "c29e2aca-1fc9-4e81-ab95-ccf0e68eb0b5",
        "created_at": 1774173583.095533,
        "updated_at": null,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "brand": "387ee90b-c91a-40cd-a1c5-f819e9151ac4",
        "file": {
          "id": "87867d00-e63b-4070-9024-3cd55f9753b9",
          "created_at": 1774173583.089778,
          "updated_at": 1774173583.089778,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "path": "brands/assets/d9662d90-25d5-11f1-83ca-c9fd0d26db3c.png",
          "name": "logo.png",
          "public": true,
          "type": "file",
          "url": "https://test.cloudfront.net/brands/assets/d9662d90-25d5-11f1-83ca-c9fd0d26db3c.png",
          "preview_url": "https://test.cloudfront.net/brands/assets/d9662d90-25d5-11f1-83ca-c9fd0d26db3c.png",
          "mime": "image/png"
        },
        "label": "Asset Label",
        "template_type": "Christmas",
        "medium": "Email",
        "branch": null,
        "type": "brand_asset"
      },
      "post_link": "http://test.com",
      "failed_at": null,
      "failure": null,
      "media_container_id": "test",
      "type": "social_post",
      "created_at": 1774173583.841614,
      "updated_at": 1774173583.841614,
      "deleted_at": null,
      "due_at": 1774172983.804,
      "executed_at": 1774173582.559825,
      "owner": {
        "type": "user",
        "username": null,
        "first_name": "Unit",
        "last_name": "Test",
        "email": "[email protected]",
        "phone_number": "+4368120265807",
        "created_at": 1493115498.770362,
        "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "address_id": null,
        "cover_image_url": null,
        "profile_image_url": null,
        "updated_at": 1493115498.770744,
        "user_status": "Active",
        "profile_image_thumbnail_url": null,
        "cover_image_thumbnail_url": null,
        "email_confirmed": true,
        "timezone": "America/Chicago",
        "user_type": "Admin",
        "deleted_at": null,
        "phone_confirmed": false,
        "is_shadow": false,
        "personal_room": null,
        "brand": null,
        "fake_email": false,
        "features": [
          "Deals"
        ],
        "last_seen_at": null,
        "email_signature": null,
        "daily_enabled": false,
        "email_quota": 30000,
        "website": null,
        "instagram": null,
        "twitter": null,
        "linkedin": null,
        "youtube": null,
        "facebook": null,
        "designation": null,
        "tiktok": null,
        "mfa_enabled": false,
        "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "current_time": "4:59 AM - Sunday Mar 22, 2026",
        "push_allowed": false,
        "agents": null,
        "last_seen_type": null,
        "active_brand": "387ee90b-c91a-40cd-a1c5-f819e9151ac4",
        "display_name": "Unit Test",
        "abbreviated_display_name": "Unit",
        "online_state": "Offline",
        "has_password": true
      }
    },
    {
      "id": "e65248a2-e073-491a-a4a5-9ec247f6a606",
      "brand": "387ee90b-c91a-40cd-a1c5-f819e9151ac4",
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "caption": "this post should be failed in job",
      "facebook_page": "464ac68a-94a0-4caf-bd1d-bb242e27e7d7",
      "template_instance": {
        "id": "992efcfe-718d-49c6-9ad1-57dbcfc56398",
        "created_at": 1774173582.559825,
        "html": "<div>fakeTemplateInstance</div>",
        "file": {
          "id": "aa1b3182-af4e-4351-bf09-332808f8a23e",
          "created_at": 1774173583.657976,
          "updated_at": 1774173583.657976,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "path": "templates/instances/d9bdc370-25d5-11f1-83ca-c9fd0d26db3c.png",
          "name": "image.png",
          "public": true,
          "type": "file",
          "url": "https://test.cloudfront.net/templates/instances/d9bdc370-25d5-11f1-83ca-c9fd0d26db3c.png",
          "preview_url": "https://test.cloudfront.net/templates/instances/d9bdc370-25d5-11f1-83ca-c9fd0d26db3c.png",
          "mime": "image/png"
        },
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "branch": "http://mock-branch-url",
        "updated_at": 1774173582.559825,
        "deleted_at": null,
        "type": "template_instance"
      },
      "asset": null,
      "post_link": null,
      "failed_at": "2026-03-22T09:59:42.559Z",
      "failure": "Internal Server Error",
      "media_container_id": "test",
      "type": "social_post",
      "created_at": 1774173583.891633,
      "updated_at": 1774173583.891633,
      "deleted_at": null,
      "due_at": 1774172983.856,
      "executed_at": 1774173582.559825,
      "owner": {
        "type": "user",
        "username": null,
        "first_name": "Unit",
        "last_name": "Test",
        "email": "[email protected]",
        "phone_number": "+4368120265807",
        "created_at": 1493115498.770362,
        "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "address_id": null,
        "cover_image_url": null,
        "profile_image_url": null,
        "updated_at": 1493115498.770744,
        "user_status": "Active",
        "profile_image_thumbnail_url": null,
        "cover_image_thumbnail_url": null,
        "email_confirmed": true,
        "timezone": "America/Chicago",
        "user_type": "Admin",
        "deleted_at": null,
        "phone_confirmed": false,
        "is_shadow": false,
        "personal_room": null,
        "brand": null,
        "fake_email": false,
        "features": [
          "Deals"
        ],
        "last_seen_at": null,
        "email_signature": null,
        "daily_enabled": false,
        "email_quota": 30000,
        "website": null,
        "instagram": null,
        "twitter": null,
        "linkedin": null,
        "youtube": null,
        "facebook": null,
        "designation": null,
        "tiktok": null,
        "mfa_enabled": false,
        "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "current_time": "4:59 AM - Sunday Mar 22, 2026",
        "push_allowed": false,
        "agents": null,
        "last_seen_type": null,
        "active_brand": "387ee90b-c91a-40cd-a1c5-f819e9151ac4",
        "display_name": "Unit Test",
        "abbreviated_display_name": "Unit",
        "online_state": "Offline",
        "has_password": true
      }
    }
  ],
  "info": {
    "count": 3,
    "total": 3
  }
}

Get Social posts stats of brand

Get Social posts stats of brand
GET/brands/:brand/social-posts/stats{?status}

brand (uuid) ID of the brand

user (uuid) ID of the user (optional)

status (‘executed’ | ‘scheduled’ | ‘draft’ | ‘any’) string (optional)

Example URI

GET /brands/:brand/social-posts/stats?status=executed
URI Parameters
HideShow
brand
string (required) Example: 387ee90b-c91a-40cd-a1c5-f819e9151ac4
status
string (required) Example: executed
Response  200
HideShow
Body
{
  "type": "social_post_stats",
  "Email": "1",
  "Social": "2"
}

Create a social post with templateInstance

Create a social post with templateInstance
POST/brands/:brand/social-posts

Example URI

POST /brands/:brand/social-posts
URI Parameters
HideShow
brand
string (required) Example: 387ee90b-c91a-40cd-a1c5-f819e9151ac4
associations
string (required) Example: social_post.template_instance,social_post.owner
Request
HideShow
Body
{
  "facebook_page": "5c6b715f-4b6e-40db-bd51-9382d7d9e683",
  "template_instance": "992efcfe-718d-49c6-9ad1-57dbcfc56398",
  "due_at": 1774172983.71,
  "caption": "test"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "53d64a2e-0130-4202-a950-c8333b1ad2ff",
    "brand": "387ee90b-c91a-40cd-a1c5-f819e9151ac4",
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "caption": "test",
    "facebook_page": "5c6b715f-4b6e-40db-bd51-9382d7d9e683",
    "template_instance": {
      "id": "992efcfe-718d-49c6-9ad1-57dbcfc56398",
      "created_at": 1774173582.559825,
      "html": "<div>fakeTemplateInstance</div>",
      "file": {
        "id": "aa1b3182-af4e-4351-bf09-332808f8a23e",
        "created_at": 1774173583.657976,
        "updated_at": 1774173583.657976,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "path": "templates/instances/d9bdc370-25d5-11f1-83ca-c9fd0d26db3c.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/d9bdc370-25d5-11f1-83ca-c9fd0d26db3c.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/d9bdc370-25d5-11f1-83ca-c9fd0d26db3c.png",
        "mime": "image/png"
      },
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "branch": "http://mock-branch-url",
      "updated_at": 1774173582.559825,
      "deleted_at": null,
      "type": "template_instance"
    },
    "post_link": null,
    "failed_at": null,
    "failure": null,
    "media_container_id": null,
    "type": "social_post",
    "created_at": 1774173583.748516,
    "updated_at": 1774173583.748516,
    "deleted_at": null,
    "due_at": 1774172983.71,
    "executed_at": null,
    "owner": {
      "type": "user",
      "username": null,
      "first_name": "Unit",
      "last_name": "Test",
      "email": "[email protected]",
      "phone_number": "+4368120265807",
      "created_at": 1493115498.770362,
      "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "address_id": null,
      "cover_image_url": null,
      "profile_image_url": null,
      "updated_at": 1493115498.770744,
      "user_status": "Active",
      "profile_image_thumbnail_url": null,
      "cover_image_thumbnail_url": null,
      "email_confirmed": true,
      "timezone": "America/Chicago",
      "user_type": "Admin",
      "deleted_at": null,
      "phone_confirmed": false,
      "is_shadow": false,
      "personal_room": null,
      "brand": null,
      "fake_email": false,
      "features": [
        "Deals"
      ],
      "last_seen_at": null,
      "email_signature": null,
      "daily_enabled": false,
      "email_quota": 30000,
      "website": null,
      "instagram": null,
      "twitter": null,
      "linkedin": null,
      "youtube": null,
      "facebook": null,
      "designation": null,
      "tiktok": null,
      "mfa_enabled": false,
      "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "current_time": "4:59 AM - Sunday Mar 22, 2026",
      "push_allowed": false,
      "agents": null,
      "last_seen_type": null,
      "active_brand": "387ee90b-c91a-40cd-a1c5-f819e9151ac4",
      "display_name": "Unit Test",
      "abbreviated_display_name": "Unit",
      "online_state": "Offline",
      "has_password": true
    }
  }
}

Create a social post with asset

Create a social post with asset
POST/brands/:brand/social-posts

Example URI

POST /brands/:brand/social-posts
URI Parameters
HideShow
brand
string (required) Example: 387ee90b-c91a-40cd-a1c5-f819e9151ac4
Request
HideShow
Body
{
  "facebook_page": "5c6b715f-4b6e-40db-bd51-9382d7d9e683",
  "asset": "c29e2aca-1fc9-4e81-ab95-ccf0e68eb0b5",
  "due_at": 1774172983.804,
  "caption": "testAsset"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "7c575539-2681-4dad-9640-75b462d86827",
    "brand": "387ee90b-c91a-40cd-a1c5-f819e9151ac4",
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "caption": "testAsset",
    "facebook_page": "5c6b715f-4b6e-40db-bd51-9382d7d9e683",
    "post_link": null,
    "failed_at": null,
    "failure": null,
    "media_container_id": null,
    "type": "social_post",
    "created_at": 1774173583.841614,
    "updated_at": 1774173583.841614,
    "deleted_at": null,
    "due_at": 1774172983.804,
    "executed_at": null
  }
}

Update social post

Update social post
PUT/brands/:brand/social-posts/:socialPostId

Example URI

PUT /brands/:brand/social-posts/:socialPostId
URI Parameters
HideShow
brand
string (required) Example: 387ee90b-c91a-40cd-a1c5-f819e9151ac4
socialPostId
string (required) Example: 72347b5d-c743-43a8-ab5b-24f038310674
Request
HideShow
Body
{
  "due_at": 1774174183.898,
  "template_instance": "992efcfe-718d-49c6-9ad1-57dbcfc56398",
  "facebook_page": "464ac68a-94a0-4caf-bd1d-bb242e27e7d7",
  "asset": null,
  "caption": "test"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "72347b5d-c743-43a8-ab5b-24f038310674",
    "brand": "387ee90b-c91a-40cd-a1c5-f819e9151ac4",
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "caption": "test",
    "facebook_page": "464ac68a-94a0-4caf-bd1d-bb242e27e7d7",
    "post_link": null,
    "failed_at": null,
    "failure": null,
    "media_container_id": null,
    "type": "social_post",
    "created_at": 1774173583.797258,
    "updated_at": 1774173582.559825,
    "deleted_at": null,
    "due_at": 1774174183.898,
    "executed_at": null
  }
}

Delete a social post

Delete a social post
DELETE/brands/:brand/social-posts/:socialPostId

Example URI

DELETE /brands/:brand/social-posts/:socialPostId
URI Parameters
HideShow
brand
string (required) Example: 387ee90b-c91a-40cd-a1c5-f819e9151ac4
socialPostId
string (required) Example: 31d524b0-680b-4ebc-b70a-6009a32d4d70
Response  204

Generated by aglio on 22 Mar 2026