User Permissions API

This API specification describes the webhook endpoint that your server must implement to provide user permissions for the Stripo Email Editor.

The Stripo Plugin enforces role-based access control by calling your endpoint to retrieve permissions for each user session. This allows you to define granular access controls for different parts of the editor (code editor, appearance settings, content editing, modules, version history, and comments management).

How It Works:

Configure the User Permissions API endpoint in your Stripo Plugin settings
When a user opens the editor, Stripo calls your endpoint with user metadata
Your server responds with a JSON object specifying which actions are allowed
The editor enforces these permissions by enabling or disabling features

Authentication: HTTP Basic Authentication is required. Configure credentials in the plugin settings: Plugin → Server Settings → User Permissions API.

Performance: This endpoint is called during editor initialization, so response time should be optimized (recommended: < 500ms).

Server

https://{YOUR_USER_PERMISSIONS_CHECKER_URL}

YOUR_USER_PERMISSIONS_CHECKER_URL

Your user permissions webhook endpoint

Client Libraries

Shell Curl

Methods

User permissions API endpoints

Methods Operations

get/

Get user permissions for email template

Retrieves the set of permissions granted to a specific user for a particular email template.

The Stripo editor calls this endpoint during initialization with user metadata in the ES-PLUGIN-UI-DATA header. Your server should:

Parse the metadata to identify the user and email template
Check the user's role and permissions in your system
Return a JSON object specifying which editor features are accessible

Use Cases:

Restrict content editing for reviewers (read-only access)
Allow text-only editing for copywriters
Grant full access to administrators
Control comment creation and moderation capabilities
Manage module library access

Performance Considerations: This endpoint is called on every editor initialization, so responses should be fast (< 500ms recommended) and may be cached by your application.

Headers

ES-PLUGIN-UI-DATA
Type: string
required

User and email template metadata that was passed during editor initialization. This header contains the metadata object you provided in the window.Stripo.init() call. Typically includes email ID, and any custom context data.

The value is URL-encoded JSON. Your server should decode and parse this to identify the user and determine their permissions.
Cookies
Type: string
required

Browser cookies from the user's session. Can be used for additional authentication or session validation if needed.

Responses

200
Type: object ·
User permissions retrieved successfully.

Complete set of user permissions for the email editor. Each permission group controls access to specific editor features and capabilities.

Permission Groups:

codeEditor: HTML code editor access

appearance: Design and styling controls (fonts, colors, themes)

content: Template content editing (blocks, text, images, layout)

modules: Custom module library access (create, edit, delete saved modules)

versionHistory: Version control features (view history, restore versions)

manageOwnComments: Comment creation and participation

accessibilityTesting: Accessibility Testing Mode access and editing behavior

manageAllComments: Comment moderation and management

Permission Logic:

read: false hides the feature from the UI entirely

read: true, write: false shows the feature but in read-only mode

read: true, write: true grants full access to the feature
accessibilityTesting

Standard permission value structure with read and write access flags.
Controls access to the Accessibility Testing Mode in the editor.

Note: write: true is meaningless if read: false

read
Type: boolean

Controls visibility and read access to the feature.

true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely

write
Type: boolean

Controls modification permissions for the feature.

true: User can make changes and save modifications false: Feature is read-only (requires read: true)

Note: write: true is meaningless if read: false

appearance

Controls access to appearance settings (fonts, colors, styles, theme customization).

read: true - User can view current appearance settings and design system values.

write: true - User can modify appearance settings, affecting the overall look and feel of the email template (global colors, fonts, spacing).

Use Case: Restrict appearance changes to brand managers and designers while allowing editors to view the current settings.

read
Type: boolean

Controls visibility and read access to the feature.

true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely

write
Type: boolean

Controls modification permissions for the feature.

true: User can make changes and save modifications false: Feature is read-only (requires read: true)

Note: write: true is meaningless if read: false

codeEditor

Controls access to the HTML code editor.

read: true - User can open and view the HTML source code of the email template. Useful for developers who need to inspect the markup.

write: true - User can edit and save changes to the HTML code. Requires technical knowledge. Should be restricted to developers and administrators.

Use Case: Grant read-only access to designers who need to inspect HTML but shouldn't modify it directly.

read
Type: boolean

Controls visibility and read access to the feature.

true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely

write
Type: boolean

Controls modification permissions for the feature.

true: User can make changes and save modifications false: Feature is read-only (requires read: true)

Note: write: true is meaningless if read: false

content

Controls access to template content editing capabilities.

read: true - User can view the email template content.

write: true - User can add/remove blocks, modify layout, change images, and fully edit the template structure.

textOnly: true - Special mode that allows only text editing without structural changes. Ideal for copywriters and translators. When enabled, write should be false.

Use Cases:

Copywriters: read: true, write: false, textOnly: true

Reviewers: read: true, write: false, textOnly: false

Content editors: read: true, write: true, textOnly: false

read
Type: boolean

Controls visibility and read access to the template content.

true: User can view the email template content false: User cannot access the template content at all

textOnly
Type: boolean

Enables text-only editing mode for copywriters and translators.

true: User can edit text content within existing blocks but cannot modify layout, add/remove blocks, or change design elements. Perfect for copywriters and translators who should focus only on content.

false: Standard editing mode (controlled by write permission)

Important: When textOnly: true, the write permission should be false. The textOnly flag provides a special editing mode separate from full write access.

write
Type: boolean

Controls full content modification permissions.

true: User can add/remove blocks, change layout, edit text, modify images, and make any structural changes to the template

false: User cannot make structural changes (but may still edit text if textOnly: true)

manageAllComments

Controls comment moderation capabilities across all users.

read: true - Currently not utilized by the system. Reserved for future use.

write: true - User can edit and delete comments created by any user, providing full moderation capabilities. This is in addition to the permissions granted by manageOwnComments.

Use Case:

Administrators/Moderators: write: true (can moderate all comments)

Regular users: write: false (can only manage their own comments via manageOwnComments)

Important: This permission grants elevated privileges and should only be given to trusted administrators or moderators who need to manage inappropriate content or maintain discussion quality.

read
Type: boolean

Controls visibility and read access to the feature.

true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely

write
Type: boolean

Controls modification permissions for the feature.

true: User can make changes and save modifications false: Feature is read-only (requires read: true)

Note: write: true is meaningless if read: false

manageOwnComments

Controls the user's ability to participate in commenting and collaboration.

read: true - User can open the Comments tab and view all existing comments on the email template. This allows them to see feedback and discussions.

write: true - User can create new comments, reply to existing comment threads, and participate in discussions. They can edit and delete their own comments.

Use Case:

Collaborators: read: true, write: true (can participate in discussions)

Reviewers: read: true, write: false (can see feedback but not comment)

External viewers: read: false, write: false (no access to comments)

Note: Users with write access can only manage their own comments. To allow editing/deleting other users' comments, use manageAllComments.

read
Type: boolean

Controls visibility and read access to the feature.

true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely

write
Type: boolean

Controls modification permissions for the feature.

true: User can make changes and save modifications false: Feature is read-only (requires read: true)

Note: write: true is meaningless if read: false

modules

Controls access to the custom module library (saved template blocks).

read: true - User can browse the module library and insert saved modules into email templates.

write: true - User can create new modules, update existing ones, and delete modules from the library.

Use Case: All users can typically insert modules (read: true), but only designers and administrators should create/modify modules (write: true).

read
Type: boolean

Controls visibility and read access to the feature.

true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely

write
Type: boolean

Controls modification permissions for the feature.

true: User can make changes and save modifications false: Feature is read-only (requires read: true)

Note: write: true is meaningless if read: false

versionHistory

Controls access to email template version history and restoration features.

read: true - User can view the version history, see who made changes and when, and preview previous versions.

write: true - User can restore previous versions of the email template, effectively reverting changes.

Use Case: Allow all editors to view history (read: true) but restrict version restoration to administrators (write: true) to prevent accidental data loss.

read
Type: boolean

Controls visibility and read access to the feature.

true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely

write
Type: boolean

Controls modification permissions for the feature.

true: User can make changes and save modifications false: Feature is read-only (requires read: true)

Note: write: true is meaningless if read: false
application/json

get/

curl 'https://{YOUR_USER_PERMISSIONS_CHECKER_URL}/' \
  --header 'ES-PLUGIN-UI-DATA: {"emailId":"456","projectId":"789"}' \
  --header 'Cookies: sessionId=abc123;' \
  --header 'Authorization: Basic username:password'

Show Schema

{
  "codeEditor": {
    "read": true,
    "write": true
  },
  "appearance": {
    "read": true,
    "write": true
  },
  "content": {
    "read": true,
    "write": true,
    "textOnly": false
  },
  "modules": {
    "read": true,
    "write": true
  },
  "versionHistory": {
    "read": true,
    "write": true
  },
  "manageOwnComments": {
    "read": true,
    "write": true
  },
  "manageAllComments": {
    "read": true,
    "write": true
  },
  "accessibilityTesting": {
    "read": true,
    "write": true
  }
}

User permissions retrieved successfully.

Models

Complete set of user permissions for the email editor. Each permission group controls access to specific editor features and capabilities.

Permission Groups:

codeEditor: HTML code editor access
appearance: Design and styling controls (fonts, colors, themes)
content: Template content editing (blocks, text, images, layout)
modules: Custom module library access (create, edit, delete saved modules)
versionHistory: Version control features (view history, restore versions)
manageOwnComments: Comment creation and participation
accessibilityTesting: Accessibility Testing Mode access and editing behavior
manageAllComments: Comment moderation and management

Permission Logic:

read: false hides the feature from the UI entirely
read: true, write: false shows the feature but in read-only mode
read: true, write: true grants full access to the feature

accessibilityTesting
Standard permission value structure with read and write access flags.
Controls access to the Accessibility Testing Mode in the editor.

Note: write: true is meaningless if read: false
- read
  Type: boolean
  
  Controls visibility and read access to the feature.
  
  true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely
- write
  Type: boolean
  
  Controls modification permissions for the feature.
  
  true: User can make changes and save modifications false: Feature is read-only (requires read: true)
  
  Note: write: true is meaningless if read: false
appearance
Controls access to appearance settings (fonts, colors, styles, theme customization).

read: true - User can view current appearance settings and design system values.

write: true - User can modify appearance settings, affecting the overall look and feel of the email template (global colors, fonts, spacing).

Use Case: Restrict appearance changes to brand managers and designers while allowing editors to view the current settings.
- read
  Type: boolean
  
  Controls visibility and read access to the feature.
  
  true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely
- write
  Type: boolean
  
  Controls modification permissions for the feature.
  
  true: User can make changes and save modifications false: Feature is read-only (requires read: true)
  
  Note: write: true is meaningless if read: false
codeEditor
Controls access to the HTML code editor.

read: true - User can open and view the HTML source code of the email template. Useful for developers who need to inspect the markup.

write: true - User can edit and save changes to the HTML code. Requires technical knowledge. Should be restricted to developers and administrators.

Use Case: Grant read-only access to designers who need to inspect HTML but shouldn't modify it directly.
- read
  Type: boolean
  
  Controls visibility and read access to the feature.
  
  true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely
- write
  Type: boolean
  
  Controls modification permissions for the feature.
  
  true: User can make changes and save modifications false: Feature is read-only (requires read: true)
  
  Note: write: true is meaningless if read: false
content
Controls access to template content editing capabilities.

read: true - User can view the email template content.

write: true - User can add/remove blocks, modify layout, change images, and fully edit the template structure.

textOnly: true - Special mode that allows only text editing without structural changes. Ideal for copywriters and translators. When enabled, write should be false.

Use Cases:

Copywriters: read: true, write: false, textOnly: true

Reviewers: read: true, write: false, textOnly: false

Content editors: read: true, write: true, textOnly: false
- read
  Type: boolean
  
  Controls visibility and read access to the template content.
  
  true: User can view the email template content false: User cannot access the template content at all
- textOnly
  Type: boolean
  
  Enables text-only editing mode for copywriters and translators.
  
  true: User can edit text content within existing blocks but cannot modify layout, add/remove blocks, or change design elements. Perfect for copywriters and translators who should focus only on content.
  
  false: Standard editing mode (controlled by write permission)
  
  Important: When textOnly: true, the write permission should be false. The textOnly flag provides a special editing mode separate from full write access.
- write
  Type: boolean
  
  Controls full content modification permissions.
  
  true: User can add/remove blocks, change layout, edit text, modify images, and make any structural changes to the template
  
  false: User cannot make structural changes (but may still edit text if textOnly: true)
manageAllComments
Controls comment moderation capabilities across all users.

read: true - Currently not utilized by the system. Reserved for future use.

write: true - User can edit and delete comments created by any user, providing full moderation capabilities. This is in addition to the permissions granted by manageOwnComments.

Use Case:

Administrators/Moderators: write: true (can moderate all comments)

Regular users: write: false (can only manage their own comments via manageOwnComments)

Important: This permission grants elevated privileges and should only be given to trusted administrators or moderators who need to manage inappropriate content or maintain discussion quality.
- read
  Type: boolean
  
  Controls visibility and read access to the feature.
  
  true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely
- write
  Type: boolean
  
  Controls modification permissions for the feature.
  
  true: User can make changes and save modifications false: Feature is read-only (requires read: true)
  
  Note: write: true is meaningless if read: false
manageOwnComments
Controls the user's ability to participate in commenting and collaboration.

read: true - User can open the Comments tab and view all existing comments on the email template. This allows them to see feedback and discussions.

write: true - User can create new comments, reply to existing comment threads, and participate in discussions. They can edit and delete their own comments.

Use Case:

Collaborators: read: true, write: true (can participate in discussions)

Reviewers: read: true, write: false (can see feedback but not comment)

External viewers: read: false, write: false (no access to comments)

Note: Users with write access can only manage their own comments. To allow editing/deleting other users' comments, use manageAllComments.
- read
  Type: boolean
  
  Controls visibility and read access to the feature.
  
  true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely
- write
  Type: boolean
  
  Controls modification permissions for the feature.
  
  true: User can make changes and save modifications false: Feature is read-only (requires read: true)
  
  Note: write: true is meaningless if read: false
modules
Controls access to the custom module library (saved template blocks).

read: true - User can browse the module library and insert saved modules into email templates.

write: true - User can create new modules, update existing ones, and delete modules from the library.

Use Case: All users can typically insert modules (read: true), but only designers and administrators should create/modify modules (write: true).
- read
  Type: boolean
  
  Controls visibility and read access to the feature.
  
  true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely
- write
  Type: boolean
  
  Controls modification permissions for the feature.
  
  true: User can make changes and save modifications false: Feature is read-only (requires read: true)
  
  Note: write: true is meaningless if read: false
versionHistory
Controls access to email template version history and restoration features.

read: true - User can view the version history, see who made changes and when, and preview previous versions.

write: true - User can restore previous versions of the email template, effectively reverting changes.

Use Case: Allow all editors to view history (read: true) but restrict version restoration to administrators (write: true) to prevent accidental data loss.
- read
  Type: boolean
  
  Controls visibility and read access to the feature.
  
  true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely
- write
  Type: boolean
  
  Controls modification permissions for the feature.
  
  true: User can make changes and save modifications false: Feature is read-only (requires read: true)
  
  Note: write: true is meaningless if read: false

Standard permission value structure with read and write access flags. Used for most permission groups in the editor.

read
Type: boolean

Controls visibility and read access to the feature.

true: User can view and access the feature (possibly in read-only mode) false: Feature is hidden from the user interface entirely
write
Type: boolean

Controls modification permissions for the feature.

true: User can make changes and save modifications false: Feature is read-only (requires read: true)

Note: write: true is meaningless if read: false

Extended permission value structure for content editing with an additional text-only editing mode. This allows fine-grained control over content editing capabilities.

read
Type: boolean

Controls visibility and read access to the template content.

true: User can view the email template content false: User cannot access the template content at all
textOnly
Type: boolean

Enables text-only editing mode for copywriters and translators.

true: User can edit text content within existing blocks but cannot modify layout, add/remove blocks, or change design elements. Perfect for copywriters and translators who should focus only on content.

false: Standard editing mode (controlled by write permission)

Important: When textOnly: true, the write permission should be false. The textOnly flag provides a special editing mode separate from full write access.
write
Type: boolean

Controls full content modification permissions.

true: User can add/remove blocks, change layout, edit text, modify images, and make any structural changes to the template

false: User cannot make structural changes (but may still edit text if textOnly: true)

User Permissions API

Authentication

Methods

Get user permissions for email template

Models

{} UserPermissions

{} UserPermissionValue

{} UserContentPermissionValue