Print Campaign
Overview
Resource Group ¶
Get Print campaigns of brand ¶
Get Print campaigns of brandGET/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
- brand
string(required) Example: aaa775a8-9c7d-4f9d-a76d-f537f1646025- mediums
string(required) Example: Social- associations
string(required) Example: print_campaign.template_instance- order
string(required) Example: -created_at
Response
200Body
{
"code": "OK",
"data": [
{
"id": "2fa8d7c3-cf6c-4ff1-9368-87efcdb51afd",
"brand": "aaa775a8-9c7d-4f9d-a76d-f537f1646025",
"created_by": "8f46fdd2-1e79-428a-987c-13ce1a426580",
"template_instance": {
"id": "edd2d52b-7c51-46c5-8250-fc8f69a39c0e",
"created_at": 1787792167.163887,
"html": "<div>fakeTemplateInstance</div>",
"file": {
"id": "ec734cfb-a7d7-4a86-9cef-afe96309ef77",
"created_at": 1787792167.69281,
"updated_at": 1787792167.69281,
"deleted_at": null,
"created_by": "8f46fdd2-1e79-428a-987c-13ce1a426580",
"path": "templates/instances/1660f6a0-a1b2-11f1-811e-f93126d9eb55.png",
"name": "image.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/templates/instances/1660f6a0-a1b2-11f1-811e-f93126d9eb55.png",
"preview_url": "https://test.cloudfront.net/templates/instances/1660f6a0-a1b2-11f1-811e-f93126d9eb55.png",
"mime": "image/png"
},
"created_by": "8f46fdd2-1e79-428a-987c-13ce1a426580",
"branch": "http://mock-branch-url",
"updated_at": 1787792167.163887,
"deleted_at": null,
"type": "template_instance"
},
"type": "print_campaign",
"created_at": 1787792167.773366,
"updated_at": 1787792167.773368,
"deleted_at": null
}
],
"info": {
"count": 1,
"total": 1
}
}Create a print campaign ¶
Create a print campaignPOST/brands/:brand/print-campaigns
Example URI
POST /brands/:brand/print-campaigns
URI Parameters
- brand
string(required) Example: aaa775a8-9c7d-4f9d-a76d-f537f1646025- associations
string(required) Example: print_campaign.template_instance
Request
Body
{
"templateInstance": "edd2d52b-7c51-46c5-8250-fc8f69a39c0e"
}Response
200Body
{
"code": "OK",
"data": {
"id": "2fa8d7c3-cf6c-4ff1-9368-87efcdb51afd",
"brand": "aaa775a8-9c7d-4f9d-a76d-f537f1646025",
"created_by": "8f46fdd2-1e79-428a-987c-13ce1a426580",
"template_instance": {
"id": "edd2d52b-7c51-46c5-8250-fc8f69a39c0e",
"created_at": 1787792167.163887,
"html": "<div>fakeTemplateInstance</div>",
"file": {
"id": "ec734cfb-a7d7-4a86-9cef-afe96309ef77",
"created_at": 1787792167.69281,
"updated_at": 1787792167.69281,
"deleted_at": null,
"created_by": "8f46fdd2-1e79-428a-987c-13ce1a426580",
"path": "templates/instances/1660f6a0-a1b2-11f1-811e-f93126d9eb55.png",
"name": "image.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/templates/instances/1660f6a0-a1b2-11f1-811e-f93126d9eb55.png",
"preview_url": "https://test.cloudfront.net/templates/instances/1660f6a0-a1b2-11f1-811e-f93126d9eb55.png",
"mime": "image/png"
},
"created_by": "8f46fdd2-1e79-428a-987c-13ce1a426580",
"branch": "http://mock-branch-url",
"updated_at": 1787792167.163887,
"deleted_at": null,
"type": "template_instance"
},
"type": "print_campaign",
"created_at": 1787792167.773366,
"updated_at": 1787792167.773368,
"deleted_at": null
}
}update a print campaign ¶
update a print campaignPUT/brands/:brand/print-campaigns/:id
Example URI
PUT /brands/:brand/print-campaigns/:id
URI Parameters
- associations
string(required) Example: print_campaign.template_instance- brand
string(required) Example: aaa775a8-9c7d-4f9d-a76d-f537f1646025- id
string(required) Example: 2fa8d7c3-cf6c-4ff1-9368-87efcdb51afd
Request
Body
{
"templateInstance": "074b59a2-27fa-401f-ac49-892b65605981"
}Response
200Body
{
"code": "OK",
"data": {
"id": "2fa8d7c3-cf6c-4ff1-9368-87efcdb51afd",
"brand": "aaa775a8-9c7d-4f9d-a76d-f537f1646025",
"created_by": "8f46fdd2-1e79-428a-987c-13ce1a426580",
"template_instance": {
"id": "074b59a2-27fa-401f-ac49-892b65605981",
"created_at": 1787792167.163887,
"html": "<div>fake2TemplateInstance</div>",
"file": {
"id": "eab85701-12c1-4d9b-bca6-10c824b8a91c",
"created_at": 1787792167.886295,
"updated_at": 1787792167.886295,
"deleted_at": null,
"created_by": "8f46fdd2-1e79-428a-987c-13ce1a426580",
"path": "templates/instances/167eb7d0-a1b2-11f1-811e-f93126d9eb55.png",
"name": "image.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/templates/instances/167eb7d0-a1b2-11f1-811e-f93126d9eb55.png",
"preview_url": "https://test.cloudfront.net/templates/instances/167eb7d0-a1b2-11f1-811e-f93126d9eb55.png",
"mime": "image/png"
},
"created_by": "8f46fdd2-1e79-428a-987c-13ce1a426580",
"branch": "http://mock-branch-url",
"updated_at": 1787792167.163887,
"deleted_at": null,
"type": "template_instance"
},
"type": "print_campaign",
"created_at": 1787792167.773366,
"updated_at": 1787792167.951699,
"deleted_at": null
}
}Response
204get single print campaign ¶
get single print campaignGET/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
- brand
string(required) Example: aaa775a8-9c7d-4f9d-a76d-f537f1646025
Response
200Body
{
"type": "print_campaign_stats",
"Social": "1"
}get single print campaign ¶
get single print campaignGET/brands/:brand/print-campaigns/:id
Example URI
GET /brands/:brand/print-campaigns/:id
URI Parameters
- brand
string(required) Example: aaa775a8-9c7d-4f9d-a76d-f537f1646025- id
string(required) Example: 2fa8d7c3-cf6c-4ff1-9368-87efcdb51afd
Response
200Body
{
"code": "OK",
"data": {
"id": "2fa8d7c3-cf6c-4ff1-9368-87efcdb51afd",
"brand": "aaa775a8-9c7d-4f9d-a76d-f537f1646025",
"created_by": "8f46fdd2-1e79-428a-987c-13ce1a426580",
"type": "print_campaign",
"created_at": 1787792167.773366,
"updated_at": 1787792167.951699,
"deleted_at": null
}
}