Back to top

Print Campaign

Overview

Resource Group

Get Print campaigns of brand

Get Print campaigns of brand
GET/brands/:brand/print-campaigns

brand (uuid) ID of the brand

user (uuid) ID of the user (optional)

mediums (Email’ | ‘Social’ | ‘CrmOpenHouse’ | ‘FacebookCover’ | ‘InstagramStory’ | ‘LinkedInCover’ | ‘Letter’ | ‘Website’ | ‘RealtorCover’ | ‘YouTubeCover’ | ‘TwitterCover’ | ‘BusinessCard’ | ‘PostCard’ | ‘FoldedPostCard’ | ‘Brochure’ | ‘FoldedBrochure’ | ‘Newsletter’ | ‘Legal’ | ‘Flyer’ | 'IndexCard)[] array of medium

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

limit (number) limited number of records order (string) eg: +created_at

Example URI

GET /brands/:brand/print-campaigns
URI Parameters
HideShow
brand
string (required) Example: 1595a0de-4d27-4fa9-9df5-cfb44524a530
mediums
string (required) Example: Social
associations
string (required) Example: print_campaign.template_instance
order
string (required) Example: -created_at
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "e72f9c63-4605-4e19-b0ab-7269336cbfb0",
      "brand": "1595a0de-4d27-4fa9-9df5-cfb44524a530",
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "template_instance": {
        "id": "1b006dc2-9c59-4dd7-907d-9f1e279ac233",
        "created_at": 1770151211.167218,
        "html": "<div>fakeTemplateInstance</div>",
        "file": {
          "id": "3e2fe53a-b57c-4599-950b-0a871b9562ee",
          "created_at": 1770151211.516535,
          "updated_at": 1770151211.516535,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "path": "templates/instances/891d9cb0-0140-11f1-bb7b-c1ce1696c2c7.png",
          "name": "image.png",
          "public": true,
          "type": "file",
          "url": "https://test.cloudfront.net/templates/instances/891d9cb0-0140-11f1-bb7b-c1ce1696c2c7.png",
          "preview_url": "https://test.cloudfront.net/templates/instances/891d9cb0-0140-11f1-bb7b-c1ce1696c2c7.png",
          "mime": "image/png"
        },
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "branch": "http://mock-branch-url",
        "updated_at": 1770151211.167218,
        "deleted_at": null,
        "type": "template_instance"
      },
      "type": "print_campaign",
      "created_at": 1770151211.584424,
      "updated_at": 1770151211.584425,
      "deleted_at": null
    }
  ],
  "info": {
    "count": 1,
    "total": 1
  }
}

Create a print campaign

Create a print campaign
POST/brands/:brand/print-campaigns

Example URI

POST /brands/:brand/print-campaigns
URI Parameters
HideShow
brand
string (required) Example: 1595a0de-4d27-4fa9-9df5-cfb44524a530
associations
string (required) Example: print_campaign.template_instance
Request
HideShow
Body
{
  "templateInstance": "1b006dc2-9c59-4dd7-907d-9f1e279ac233"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "e72f9c63-4605-4e19-b0ab-7269336cbfb0",
    "brand": "1595a0de-4d27-4fa9-9df5-cfb44524a530",
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "template_instance": {
      "id": "1b006dc2-9c59-4dd7-907d-9f1e279ac233",
      "created_at": 1770151211.167218,
      "html": "<div>fakeTemplateInstance</div>",
      "file": {
        "id": "3e2fe53a-b57c-4599-950b-0a871b9562ee",
        "created_at": 1770151211.516535,
        "updated_at": 1770151211.516535,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "path": "templates/instances/891d9cb0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/891d9cb0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/891d9cb0-0140-11f1-bb7b-c1ce1696c2c7.png",
        "mime": "image/png"
      },
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "branch": "http://mock-branch-url",
      "updated_at": 1770151211.167218,
      "deleted_at": null,
      "type": "template_instance"
    },
    "type": "print_campaign",
    "created_at": 1770151211.584424,
    "updated_at": 1770151211.584425,
    "deleted_at": null
  }
}

update a print campaign

update a print campaign
PUT/brands/:brand/print-campaigns/:id

Example URI

PUT /brands/:brand/print-campaigns/:id
URI Parameters
HideShow
associations
string (required) Example: print_campaign.template_instance
brand
string (required) Example: 1595a0de-4d27-4fa9-9df5-cfb44524a530
id
string (required) Example: e72f9c63-4605-4e19-b0ab-7269336cbfb0
Request
HideShow
Body
{
  "templateInstance": "6aa9fc74-e247-4f0e-895f-b9980aeea732"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "e72f9c63-4605-4e19-b0ab-7269336cbfb0",
    "brand": "1595a0de-4d27-4fa9-9df5-cfb44524a530",
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "template_instance": {
      "id": "6aa9fc74-e247-4f0e-895f-b9980aeea732",
      "created_at": 1770151211.167218,
      "html": "<div>fake2TemplateInstance</div>",
      "file": {
        "id": "da0eec58-ee14-4b17-892e-a281ab75f22b",
        "created_at": 1770151211.669553,
        "updated_at": 1770151211.669553,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "path": "templates/instances/8934f540-0140-11f1-bb7b-c1ce1696c2c7.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/8934f540-0140-11f1-bb7b-c1ce1696c2c7.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/8934f540-0140-11f1-bb7b-c1ce1696c2c7.png",
        "mime": "image/png"
      },
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "branch": "http://mock-branch-url",
      "updated_at": 1770151211.167218,
      "deleted_at": null,
      "type": "template_instance"
    },
    "type": "print_campaign",
    "created_at": 1770151211.584424,
    "updated_at": 1770151211.734142,
    "deleted_at": null
  }
}
Response  204

get single print campaign

get single print campaign
GET/brands/:brand/print-campaigns/stats

brand (uuid) ID of the brand user (uuid) ID of the user (optional)

Example URI

GET /brands/:brand/print-campaigns/stats
URI Parameters
HideShow
brand
string (required) Example: 1595a0de-4d27-4fa9-9df5-cfb44524a530
Response  200
HideShow
Body
{
  "type": "print_campaign_stats",
  "Social": "1"
}

get single print campaign

get single print campaign
GET/brands/:brand/print-campaigns/:id

Example URI

GET /brands/:brand/print-campaigns/:id
URI Parameters
HideShow
brand
string (required) Example: 1595a0de-4d27-4fa9-9df5-cfb44524a530
id
string (required) Example: e72f9c63-4605-4e19-b0ab-7269336cbfb0
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "e72f9c63-4605-4e19-b0ab-7269336cbfb0",
    "brand": "1595a0de-4d27-4fa9-9df5-cfb44524a530",
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "type": "print_campaign",
    "created_at": 1770151211.584424,
    "updated_at": 1770151211.734142,
    "deleted_at": null
  }
}

Generated by aglio on 03 Feb 2026