Social layouts
Import and manage the layouts that arrange the cards of your social posts.
x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
application/json- body
assetIds*array<>Completed layout_import uploads, one per card of the post; each is deleted once read
1 <= items <= 10One candidate per image, in the order sent: a layout to review, or why the image could not be read as one. Nothing is saved, and every image is deleted.
application/json- response
candidates*array<|>curl -X POST 'https://api.nuvelics.com/api/tenant/v1/social-layouts/import' \ -H 'Content-Type: application/json' \ -d '{ "assetIds": [ "string" ]}'{ "candidates": [ { "assetId": "string", "status": "ok", "layout": { "photo": true, "shapes": [ { "type": "box", "anchor": "top", "x": 0, "y": 0, "w": 1, "h": 1, "fill": "background", "radius": 0 } ], "boxes": [ { "role": "kicker", "anchor": "top", "x": 0, "y": 0, "w": 1, "h": 1, "ground": "background", "tag": true, "align": "left", "valign": "top", "case": "asWritten", "face": "display", "weight": 400, "italic": true, "maxSize": 12, "cap": 1, "emphasis": true } ], "logo": { "placement": "kit", "pill": true }, "formats": [ "3:4" ] }, "sourceFormat": "3:4", "offShape": true, "colors": [ { "hex": "string", "role": "background" } ], "creditAdded": true, "unexpressed": [ "string" ] } ]}x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
isActive?stringNarrow the list to active (true) or retired (false) layouts
"true""false"The org's own social layouts
application/json- response
items*array<>curl -X GET 'https://api.nuvelics.com/api/tenant/v1/social-layouts'{ "items": [ { "id": "string", "orgId": "string", "name": "string", "isActive": true, "createdAt": "2019-08-24T14:15:22Z", "layout": { "photo": true, "shapes": [ { "type": "box", "anchor": "top", "x": 0, "y": 0, "w": 1, "h": 1, "fill": "background", "radius": 0 } ], "boxes": [ { "role": "kicker", "anchor": "top", "x": 0, "y": 0, "w": 1, "h": 1, "ground": "background", "tag": true, "align": "left", "valign": "top", "case": "asWritten", "face": "display", "weight": 400, "italic": true, "maxSize": 12, "cap": 1, "emphasis": true } ], "logo": { "placement": "kit", "pill": true }, "formats": [ "3:4" ] }, "sourceUrl": "http://example.com" } ]}x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
application/json- body
name*stringDisplay name of the layout
1 <= length <= 120sourceUrl?stringLink to the post the layout was imported from; stored, never fetched
urilength <= 2048candidate*sourceFormat*stringThe shape the candidate was read at, as the import returned it; it is always among the saved formats
"3:4""4:5""1:1""9:16"boxes*array<>One entry per candidate box, in order: its role and cap (never above the candidate's, or the new role's default if that is higher), or null to remove it
shapes*array<boolean>One entry per candidate shape, in order: false removes it
formats*array<>Shapes the layout is offered in, among the candidate's
1 <= itemsSocial layout created
application/json- response
id*stringOrg social layout identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$orgId*stringname*stringDisplay name of the layout
1 <= length <= 120isActive*booleanAn inactive layout is out of the template picker; templates already naming it keep generating with it
createdAt*stringdate-timelayout*sourceUrl?stringLink to the post the layout was imported from; stored, never fetched
urilength <= 2048curl -X POST 'https://api.nuvelics.com/api/tenant/v1/social-layouts' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "candidate": { "photo": true, "shapes": [ { "type": "box", "anchor": "top", "x": 0, "y": 0, "w": 1, "h": 1, "fill": "background", "radius": 0 } ], "boxes": [ { "role": "kicker", "anchor": "top", "x": 0, "y": 0, "w": 1, "h": 1, "ground": "background", "tag": true, "align": "left", "valign": "top", "case": "asWritten", "face": "display", "weight": 400, "italic": true, "maxSize": 12, "cap": 1, "emphasis": true } ], "logo": { "placement": "kit", "pill": true }, "formats": [ "3:4" ] }, "sourceFormat": "3:4", "boxes": [ { "role": "kicker", "cap": 1 } ], "shapes": [ true ], "formats": [ "3:4" ]}'{ "id": "string", "orgId": "string", "name": "string", "isActive": true, "createdAt": "2019-08-24T14:15:22Z", "layout": { "photo": true, "shapes": [ { "type": "box", "anchor": "top", "x": 0, "y": 0, "w": 1, "h": 1, "fill": "background", "radius": 0 } ], "boxes": [ { "role": "kicker", "anchor": "top", "x": 0, "y": 0, "w": 1, "h": 1, "ground": "background", "tag": true, "align": "left", "valign": "top", "case": "asWritten", "face": "display", "weight": 400, "italic": true, "maxSize": 12, "cap": 1, "emphasis": true } ], "logo": { "placement": "kit", "pill": true }, "formats": [ "3:4" ] }, "sourceUrl": "http://example.com"}x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
id*stringOrg social layout identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$The social layout
application/json- response
id*stringOrg social layout identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$orgId*stringname*stringDisplay name of the layout
1 <= length <= 120isActive*booleanAn inactive layout is out of the template picker; templates already naming it keep generating with it
createdAt*stringdate-timelayout*sourceUrl?stringLink to the post the layout was imported from; stored, never fetched
urilength <= 2048curl -X GET 'https://api.nuvelics.com/api/tenant/v1/social-layouts/string'{ "id": "string", "orgId": "string", "name": "string", "isActive": true, "createdAt": "2019-08-24T14:15:22Z", "layout": { "photo": true, "shapes": [ { "type": "box", "anchor": "top", "x": 0, "y": 0, "w": 1, "h": 1, "fill": "background", "radius": 0 } ], "boxes": [ { "role": "kicker", "anchor": "top", "x": 0, "y": 0, "w": 1, "h": 1, "ground": "background", "tag": true, "align": "left", "valign": "top", "case": "asWritten", "face": "display", "weight": 400, "italic": true, "maxSize": 12, "cap": 1, "emphasis": true } ], "logo": { "placement": "kit", "pill": true }, "formats": [ "3:4" ] }, "sourceUrl": "http://example.com"}x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
id*stringOrg social layout identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$application/json- body
name?stringDisplay name of the layout
1 <= length <= 120isActive?booleanformats?array<>Still formats the layout is offered in
1 <= itemsSocial layout updated
application/json- response
id*stringOrg social layout identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$orgId*stringname*stringDisplay name of the layout
1 <= length <= 120isActive*booleanAn inactive layout is out of the template picker; templates already naming it keep generating with it
createdAt*stringdate-timelayout*sourceUrl?stringLink to the post the layout was imported from; stored, never fetched
urilength <= 2048curl -X PATCH 'https://api.nuvelics.com/api/tenant/v1/social-layouts/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "string", "orgId": "string", "name": "string", "isActive": true, "createdAt": "2019-08-24T14:15:22Z", "layout": { "photo": true, "shapes": [ { "type": "box", "anchor": "top", "x": 0, "y": 0, "w": 1, "h": 1, "fill": "background", "radius": 0 } ], "boxes": [ { "role": "kicker", "anchor": "top", "x": 0, "y": 0, "w": 1, "h": 1, "ground": "background", "tag": true, "align": "left", "valign": "top", "case": "asWritten", "face": "display", "weight": 400, "italic": true, "maxSize": 12, "cap": 1, "emphasis": true } ], "logo": { "placement": "kit", "pill": true }, "formats": [ "3:4" ] }, "sourceUrl": "http://example.com"}x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
id*stringOrg social layout identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Social layout deleted
curl -X DELETE 'https://api.nuvelics.com/api/tenant/v1/social-layouts/string'