Social Post

Create a social post with templateInstance

POST/brands/:brand/social-posts

Example URI

{
  "facebook_page": "83fff4ac-d774-4bc9-8b4b-a03af93b0a5d",
  "template_instance": "33d5d381-11ea-4260-b324-cab11d86717e",
  "due_at": 1791655947.057,
  "caption": "test"
}

{
  "code": "OK",
  "data": {
    "id": "db29e945-e7e6-4bd2-83d9-3dde795ea349",
    "brand": "7370a7ee-c1c9-4109-b290-20bd3319ba65",
    "created_by": "d16c1adc-68bf-4c5d-ac31-556f0cae1257",
    "caption": "test",
    "facebook_page": "83fff4ac-d774-4bc9-8b4b-a03af93b0a5d",
    "template_instance": {
      "id": "33d5d381-11ea-4260-b324-cab11d86717e",
      "created_at": 1791656546.452848,
      "html": "<div>fakeTemplateInstance</div>",
      "file": {
        "id": "03f1e4da-2e46-4528-adac-35e43c3af370",
        "created_at": 1791656547.03665,
        "updated_at": 1791656547.03665,
        "deleted_at": null,
        "created_by": "d16c1adc-68bf-4c5d-ac31-556f0cae1257",
        "path": "templates/instances/8bf5cab0-c4d7-11f1-89da-fb554657817f.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/8bf5cab0-c4d7-11f1-89da-fb554657817f.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/8bf5cab0-c4d7-11f1-89da-fb554657817f.png",
        "mime": "image/png"
      },
      "created_by": "d16c1adc-68bf-4c5d-ac31-556f0cae1257",
      "branch": "http://mock-branch-url",
      "updated_at": 1791656546.452848,
      "deleted_at": null,
      "type": "template_instance"
    },
    "post_link": null,
    "failed_at": null,
    "failure": null,
    "media_container_id": null,
    "type": "social_post",
    "created_at": 1791656547.067958,
    "updated_at": 1791656547.067958,
    "deleted_at": null,
    "due_at": 1791655947.057,
    "executed_at": null,
    "owner": {
      "type": "user",
      "username": null,
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "phone_number": "+17349445880",
      "created_at": 1791656546.460403,
      "id": "d16c1adc-68bf-4c5d-ac31-556f0cae1257",
      "address_id": null,
      "cover_image_url": null,
      "profile_image_url": null,
      "updated_at": 1791656546.460421,
      "user_status": "Active",
      "profile_image_thumbnail_url": null,
      "cover_image_thumbnail_url": null,
      "email_confirmed": false,
      "timezone": "America/Chicago",
      "user_type": "Agent",
      "deleted_at": null,
      "phone_confirmed": false,
      "is_shadow": null,
      "personal_room": "728a22e5-e7fe-4f1c-aaab-3a35a4612d17",
      "brand": null,
      "fake_email": null,
      "features": null,
      "last_seen_at": null,
      "email_signature": "This is my signature.",
      "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": null,
      "bio": "This is my bio.",
      "current_time": "1:22 PM - Saturday Oct 10, 2026",
      "push_allowed": true,
      "agents": null,
      "last_seen_type": null,
      "active_brand": "7370a7ee-c1c9-4109-b290-20bd3319ba65",
      "display_name": "John Doe",
      "abbreviated_display_name": "John",
      "online_state": "Offline",
      "has_password": true
    }
  }
}

Create a social post with asset

POST/brands/:brand/social-posts

Example URI

{
  "facebook_page": "83fff4ac-d774-4bc9-8b4b-a03af93b0a5d",
  "asset": "f1202c7b-1ded-43b8-941b-adaa566e1076",
  "due_at": 1791655947.099,
  "caption": "testAsset"
}

{
  "code": "OK",
  "data": {
    "id": "b28b62d1-f947-4d6d-93b8-916c0f2edf14",
    "brand": "7370a7ee-c1c9-4109-b290-20bd3319ba65",
    "created_by": "d16c1adc-68bf-4c5d-ac31-556f0cae1257",
    "caption": "testAsset",
    "facebook_page": "83fff4ac-d774-4bc9-8b4b-a03af93b0a5d",
    "post_link": null,
    "failed_at": null,
    "failure": null,
    "media_container_id": null,
    "type": "social_post",
    "created_at": 1791656547.109218,
    "updated_at": 1791656547.109218,
    "deleted_at": null,
    "due_at": 1791655947.099,
    "executed_at": null
  }
}

Generate an AI caption recommendation

POST/brands/:brand/social-posts/:id/caption

Generates an AI recommendation for an Instagram caption for the social post. This only returns a recommendation; it does not modify the post.

When the post is tied to a listing (resolved from its template instance, or via the optional listing body param) the listing details and a sample of its photos are sent to the model so it can write a caption grounded in the actual property. For posts that are not tied to a listing (e.g. holiday/celebration templates or static assets) the post’s rendered creative image and template metadata are sent instead, so a caption is still generated.

brand (uuid) ID of the brand

id (uuid) ID of the social post

listing (uuid, optional) listing id to use as an override/fallback when the post is not linked to a listing

Example URI