For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create Template

This document contains details for the /api/v1/template endpoint, including headers, request body, response fields, and status codes.

Endpoint

Property
Value

Method

POST

URL

/api/v1/template

Headers

Header
Required
Description

Authorization

Yes

Bearer authorization token

Content-Type

Yes

application/json

mailboxUuid

Yes

Target mailbox UUID

Authorization: Bearer {token}
Content-Type: application/json
mailboxUuid: {mailboxUuid}

Request body

Field
Type
Required
Description

access

string

Yes

Template access level, such as mailbox

categories

array

Yes

Category IDs, or an empty array

data

string

Yes

Template XML serialized as a JSON string

Request example

POST /api/v1/template
Authorization: Bearer {token}
Content-Type: application/json
mailboxUuid: 9baec31c-e940-4894-b6d1-52033e1af66e

Response

Field
Type
Description

uuid

UUID

Created template UUID

version

UUID

Created template version UUID

Response example

Status codes

Code
Description

200

Success. The response contains the template UUID and version

401

Missing, invalid, or expired authorization token

403

Authenticated user cannot create templates in the target mailbox

Last updated

Was this helpful?