Skip to navigation

Update Template

A key, which acts with an app admin’s rights, or the session of an app admin of Memegen (403 admin_required for anybody else’s). Renaming and changing the slug are allowed, under the same rules as adding one: the name is folded onto one line and kept to 120 characters, and a slug another template holds is 409. Archiving one (archived: true) stops new memes being made from it; archived: false restores an archived one to the picker.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

templateIdstringRequired

Request

This endpoint expects an object.
namestringOptional

The same rules as when adding one: folded onto one line, trimmed and cut at 120 characters; one with nothing left is 422.

slugstringOptional

A slug another template holds is refused with 409.

layoutenumOptional
Where the captions sit on a template.
Allowed values:
widthintegerOptional
heightintegerOptional
attributionstringOptional
sourceUrlstringOptional

Where the credit links to: an http or https address, or 422. null clears it.

sortOrderintegerOptional
curatedbooleanOptional
archivedbooleanOptional

Response

This endpoint returns an object.
idstring
organizationIdstring
namestring
slugstring
layoutenum
Where the captions sit on a template.
Allowed values:
curatedboolean
Part of the library the workspace curates, rather than a background somebody found while composing one meme. Only curated templates appear in the picker.
archivedboolean

Out of the picker. Memes already made from it keep rendering, which is why a template is archived rather than deleted, but no new meme can be made from it. Only an app admin of Memegen, or a key, brings one back: archived: false on PATCH, or adding its picture again with POST /meme-templates, /meme-templates/from-url or /meme-templates/import, which restores it. Anybody else who adds the same picture again is refused (“An admin removed this template.”) and it stays archived.

sortOrderinteger
createdAtdatetime
updatedAtdatetime
builtinKeystringOptional
Set on the templates that ship with the app.
imageUrlstringOptional

The background, an http or https address. Absent on a built-in, which the app draws itself.

widthintegerOptional
The background's real pixel size, so the canvas can match the picture instead of cropping it into a fixed box.
heightintegerOptional
attributionstringOptional
Where a searched template came from. The background is served from there rather than copied, so the credit stays with the row.
sourceUrlstringOptional
Where the credit links to, an http or https address.

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Validation Error
429
Too Many Requests Error