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: a6317dc6-baa8-4e2a-b381-d9f3c42202e8
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": "3696693f-01e9-4e50-a7a0-5b9f67cff705",
      "brand": "a6317dc6-baa8-4e2a-b381-d9f3c42202e8",
      "created_by": "171aec33-62e0-4173-9996-da40b6bb36bf",
      "template_instance": {
        "id": "016ecd05-3777-458c-a4d5-d1472fcafaa6",
        "created_at": 1791986091.330704,
        "html": "<div>fakeTemplateInstance</div>",
        "file": {
          "id": "a602af7a-bc6c-41bc-96d7-a746ad760154",
          "created_at": 1791986091.721019,
          "updated_at": 1791986091.721019,
          "deleted_at": null,
          "created_by": "171aec33-62e0-4173-9996-da40b6bb36bf",
          "path": "templates/instances/d3e62480-c7d6-11f1-920c-95d07f504333.png",
          "name": "image.png",
          "public": true,
          "type": "file",
          "url": "https://test.cloudfront.net/templates/instances/d3e62480-c7d6-11f1-920c-95d07f504333.png",
          "preview_url": "https://test.cloudfront.net/templates/instances/d3e62480-c7d6-11f1-920c-95d07f504333.png",
          "mime": "image/png"
        },
        "created_by": "171aec33-62e0-4173-9996-da40b6bb36bf",
        "branch": "http://mock-branch-url",
        "updated_at": 1791986091.330704,
        "deleted_at": null,
        "type": "template_instance"
      },
      "type": "print_campaign",
      "created_at": 1791986091.753556,
      "updated_at": 1791986091.753556,
      "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: a6317dc6-baa8-4e2a-b381-d9f3c42202e8
associations
string (required) Example: print_campaign.template_instance
Request
HideShow
Body
{
  "templateInstance": "016ecd05-3777-458c-a4d5-d1472fcafaa6"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3696693f-01e9-4e50-a7a0-5b9f67cff705",
    "brand": "a6317dc6-baa8-4e2a-b381-d9f3c42202e8",
    "created_by": "171aec33-62e0-4173-9996-da40b6bb36bf",
    "template_instance": {
      "id": "016ecd05-3777-458c-a4d5-d1472fcafaa6",
      "created_at": 1791986091.330704,
      "html": "<div>fakeTemplateInstance</div>",
      "file": {
        "id": "a602af7a-bc6c-41bc-96d7-a746ad760154",
        "created_at": 1791986091.721019,
        "updated_at": 1791986091.721019,
        "deleted_at": null,
        "created_by": "171aec33-62e0-4173-9996-da40b6bb36bf",
        "path": "templates/instances/d3e62480-c7d6-11f1-920c-95d07f504333.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/d3e62480-c7d6-11f1-920c-95d07f504333.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/d3e62480-c7d6-11f1-920c-95d07f504333.png",
        "mime": "image/png"
      },
      "created_by": "171aec33-62e0-4173-9996-da40b6bb36bf",
      "branch": "http://mock-branch-url",
      "updated_at": 1791986091.330704,
      "deleted_at": null,
      "type": "template_instance"
    },
    "type": "print_campaign",
    "created_at": 1791986091.753556,
    "updated_at": 1791986091.753556,
    "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: a6317dc6-baa8-4e2a-b381-d9f3c42202e8
id
string (required) Example: 3696693f-01e9-4e50-a7a0-5b9f67cff705
Request
HideShow
Body
{
  "templateInstance": "c3d3cb5f-017c-4d91-a811-3db9b6dc77ea"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3696693f-01e9-4e50-a7a0-5b9f67cff705",
    "brand": "a6317dc6-baa8-4e2a-b381-d9f3c42202e8",
    "created_by": "171aec33-62e0-4173-9996-da40b6bb36bf",
    "template_instance": {
      "id": "c3d3cb5f-017c-4d91-a811-3db9b6dc77ea",
      "created_at": 1791986091.330704,
      "html": "<div>fake2TemplateInstance</div>",
      "file": {
        "id": "78e359f6-4577-4cde-b47e-746a22b3e0a5",
        "created_at": 1791986091.804341,
        "updated_at": 1791986091.804341,
        "deleted_at": null,
        "created_by": "171aec33-62e0-4173-9996-da40b6bb36bf",
        "path": "templates/instances/d3f2ceb0-c7d6-11f1-920c-95d07f504333.png",
        "name": "image.png",
        "public": true,
        "type": "file",
        "url": "https://test.cloudfront.net/templates/instances/d3f2ceb0-c7d6-11f1-920c-95d07f504333.png",
        "preview_url": "https://test.cloudfront.net/templates/instances/d3f2ceb0-c7d6-11f1-920c-95d07f504333.png",
        "mime": "image/png"
      },
      "created_by": "171aec33-62e0-4173-9996-da40b6bb36bf",
      "branch": "http://mock-branch-url",
      "updated_at": 1791986091.330704,
      "deleted_at": null,
      "type": "template_instance"
    },
    "type": "print_campaign",
    "created_at": 1791986091.753556,
    "updated_at": 1791986091.833424,
    "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: a6317dc6-baa8-4e2a-b381-d9f3c42202e8
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: a6317dc6-baa8-4e2a-b381-d9f3c42202e8
id
string (required) Example: 3696693f-01e9-4e50-a7a0-5b9f67cff705
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3696693f-01e9-4e50-a7a0-5b9f67cff705",
    "brand": "a6317dc6-baa8-4e2a-b381-d9f3c42202e8",
    "created_by": "171aec33-62e0-4173-9996-da40b6bb36bf",
    "type": "print_campaign",
    "created_at": 1791986091.753556,
    "updated_at": 1791986091.833424,
    "deleted_at": null
  }
}

Generated by aglio on 14 Oct 2026