Templates

Templates

The templates object represents a custom, user defined proposal template that has been created in the app.

{
    "id": string,
    "name": string,
    "description": string,
    "type": string,
    "preview_title": string,
    "preview_image": string,
    "enable_password": boolean,
    "enable_expires": boolean,
    "expires_type": string,
    "expires_in": number,
    "enable_view_limit": boolean,
    "view_limit_type": string,
    "view_limit": number,
    "enable_email_verification": boolean,
    "email_verification_type": string,
    "email_verification_address": string,
    "enable_search_engine": boolean,
    "owner": User,
    "collaborators": { data: User[] },
    "team_wide_access": boolean,
    "favourite": boolean, 
    "created_at": datetime,
    "updated_at": datetime,
}

id string The unique identifier for the template.

name string The name of the template.

description string The description of the template.

type string e.g. proposal or section The type of template e.g proposal template or section template.

preview_title string The title used when the template link is previewed (on social media posts, sms messages, etc).

preview_image string The image used when the template link is previewed.

enable_password boolean Indicates whether password protection is enabled for the template.

enable_expires boolean Indicates whether an expiry is set for the template.

expires_type string e.g. from_live, from_first_view The type of expiry set for the template.

expires_in number The time in days until the template expires from the configured expires_type.

enable_view_limit boolean Indicates whether a view limit is set for the template.

view_limit_type string max, max_browsers The type of view limit set for the template.

view_limit number The maximum number of views allowed for the template for the configured view_limit_type.

enable_email_verification boolean Indicates whether email verification is required for viewing the template.

email_verification_type string e.g. any, domain or specific The type of email verification required.

email_verification_address string The email address or doamin to which verification is restricted.

enable_search_engine boolean Indicates whether the template is accessible to search engines.

owner User The owner of the template.

collaborators A list of users collaborating on the template.

team_wide_access boolean Indicates whether the template is accessible to the entire team.

favourite boolean Indicates whether the template is marked as a favorite.

Retrieving a list of templates
curl https://example.api.pxmo.com/api/templates?page=1&page_size=15 \
    -H 'Authorization: Bearer {access_token}' \
    -H 'Accept: application/json'
Retrieving a single template
curl https://example.api.pxmo.com/api/templates/{id} \
    -H 'Authorization: Bearer {access_token}' \
    -H 'Accept: application/json'
Deleting a template
curl -X DELETE https://example.api.pxmo.com/api/templates/{id} \
    -H 'Authorization: Bearer {access_token}' \
    -H 'Accept: application/json'
Creating a new template
curl -X POST https://example.api.pxmo.com/api/templates/{id} \
    -H 'Authorization: Bearer {access_token}' \
    -H 'Accept: application/json'