Template Editor Sessions

Create Session

Changed on

Create a Template Editor Session.

Note that if no backURL is supplied, PostGrid removes the Back button from the editor page. This is ideal for when you iframe the editor.

post/print-mail/v1/template_editor_sessions

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/template_editor_sessions
  • Auth
    API key in header X-API-Key

Request body

templatestring required

ID of the underlying template that this edits.

backURLstring uri

The URL supplied when this editor session was created.

titlestring

The title supplied when this editor session was created.

Response

The newly created Template Editor Session.

idstring required

A unique ID prefixed with template_editor_session_.

object'template_editor_session' required

Always template_editor_session.

liveboolean required

true if this is a live mode session else false.

templatestring required

ID of the underlying template that this edits.

backURLstring uri

The URL supplied when this editor session was created.

titlestring

The title supplied when this editor session was created.

urlstring uri required

A URL that can be iframed or redirected to for editing the template.

createdAtstring date-time required

The UTC time at which this session was created.

Changes