Templates

Email template creation and editing

List Templates

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

get

/api/templates

HTTPcURLJavaScriptPython

GET /api/templates HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

[
  {
    "id": 1,
    "name": "text",
    "subject": "text",
    "body_html": "text",
    "body_text": "text",
    "attachments": [
      {
        "id": 1,
        "filename": "text",
        "mime_type": "text",
        "size": 1
      }
    ],
    "attachments_count": 0,
    "calendar_attachments_count": 0,
    "calendar_enabled": false,
    "meeting_summary": "text",
    "organizer_cn": "text",
    "organizer_email": "[e-mail]",
    "attendees": [
      {
        "cn": "text",
        "email": "[e-mail]"
      }
    ],
    "disable_forwarding": false,
    "calendar_priority": 2,
    "calendar_categories": [
      "text"
    ],
    "calendar_private": true,
    "meeting_begin": "text",
    "meeting_end": "text",
    "meeting_provider": "none",
    "meeting_url": "text",
    "meeting_tz": "text",
    "location": "text",
    "allow_responses": false,
    "include_all_targets_as_attendees": false,
    "is_calendar_reschedule": false,
    "is_calendar_cancellation": false,
    "meeting_uid": "text",
    "meeting_sequence": 1
  }
]

Create Template

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

namestringRequired

subjectstringRequired

body_htmlany ofOptional

stringOptional

or

nullOptional

body_textany ofOptional

stringOptional

or

nullOptional

attachmentsany ofOptional

object[]Optional

or

nullOptional

calendar_enabledbooleanOptionalDefault: false

meeting_summaryany ofOptional

stringOptional

or

nullOptional

organizer_cnany ofOptional

stringOptional

or

nullOptional

organizer_emailany ofOptional

string · emailOptional

or

nullOptional

attendeesany ofOptional

or

nullOptional

disable_forwardingbooleanOptionalDefault: false

calendar_priorityinteger · min: 1 · max: 3OptionalDefault: 2

calendar_categoriesany ofOptional

string[]Optional

or

nullOptional

calendar_privateany ofOptional

booleanOptional

or

nullOptional

meeting_beginany ofOptional

stringOptional

or

nullOptional

meeting_endany ofOptional

stringOptional

or

nullOptional

meeting_providerstring · enumOptionalDefault: nonePossible values:

meeting_urlany ofOptional

stringOptional

or

nullOptional

meeting_tzany ofOptional

stringOptional

or

nullOptional

locationany ofOptional

stringOptional

or

nullOptional

allow_responsesbooleanOptionalDefault: false

include_all_targets_as_attendeesany ofOptionalDefault: false

booleanOptional

or

nullOptional

is_calendar_reschedulebooleanOptionalDefault: false

is_calendar_cancellationbooleanOptionalDefault: false

meeting_uidany ofOptional

stringOptional

or

nullOptional

meeting_sequenceany ofOptional

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/api/templates

HTTPcURLJavaScriptPython

POST /api/templates HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 653

{
  "name": "text",
  "subject": "text",
  "body_html": "text",
  "body_text": "text",
  "attachments": [
    {}
  ],
  "calendar_enabled": false,
  "meeting_summary": "text",
  "organizer_cn": "text",
  "organizer_email": "[e-mail]",
  "attendees": [
    {
      "cn": "text",
      "email": "[e-mail]"
    }
  ],
  "disable_forwarding": false,
  "calendar_priority": 2,
  "calendar_categories": [
    "text"
  ],
  "calendar_private": true,
  "meeting_begin": "text",
  "meeting_end": "text",
  "meeting_provider": "none",
  "meeting_url": "text",
  "meeting_tz": "text",
  "location": "text",
  "allow_responses": false,
  "include_all_targets_as_attendees": false,
  "is_calendar_reschedule": false,
  "is_calendar_cancellation": false,
  "meeting_uid": "text",
  "meeting_sequence": 1
}

{
  "id": 1,
  "name": "text",
  "subject": "text",
  "body_html": "text",
  "body_text": "text",
  "attachments": [
    {
      "id": 1,
      "filename": "text",
      "mime_type": "text",
      "size": 1
    }
  ],
  "attachments_count": 0,
  "calendar_attachments_count": 0,
  "calendar_enabled": false,
  "meeting_summary": "text",
  "organizer_cn": "text",
  "organizer_email": "[e-mail]",
  "attendees": [
    {
      "cn": "text",
      "email": "[e-mail]"
    }
  ],
  "disable_forwarding": false,
  "calendar_priority": 2,
  "calendar_categories": [
    "text"
  ],
  "calendar_private": true,
  "meeting_begin": "text",
  "meeting_end": "text",
  "meeting_provider": "none",
  "meeting_url": "text",
  "meeting_tz": "text",
  "location": "text",
  "allow_responses": false,
  "include_all_targets_as_attendees": false,
  "is_calendar_reschedule": false,
  "is_calendar_cancellation": false,
  "meeting_uid": "text",
  "meeting_sequence": 1
}

Update Template

put

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

template_idintegerRequired

Body

application/json

nameany ofOptional

stringOptional

or

nullOptional

subjectany ofOptional

stringOptional

or

nullOptional

body_htmlany ofOptional

stringOptional

or

nullOptional

body_textany ofOptional

stringOptional

or

nullOptional

attachmentsany ofOptional

object[]Optional

or

nullOptional

calendar_enabledany ofOptional

booleanOptional

or

nullOptional

meeting_summaryany ofOptional

stringOptional

or

nullOptional

organizer_cnany ofOptional

stringOptional

or

nullOptional

organizer_emailany ofOptional

string · emailOptional

or

nullOptional

attendeesany ofOptional

or

nullOptional

disable_forwardingany ofOptional

booleanOptional

or

nullOptional

calendar_priorityany ofOptional

integer · min: 1 · max: 3Optional

or

nullOptional

calendar_categoriesany ofOptional

string[]Optional

or

nullOptional

calendar_privateany ofOptional

booleanOptional

or

nullOptional

meeting_beginany ofOptional

stringOptional

or

nullOptional

meeting_endany ofOptional

stringOptional

or

nullOptional

meeting_providerany ofOptional

string · enumOptionalPossible values:

or

nullOptional

meeting_urlany ofOptional

stringOptional

or

nullOptional

meeting_tzany ofOptional

stringOptional

or

nullOptional

locationany ofOptional

stringOptional

or

nullOptional

allow_responsesany ofOptional

booleanOptional

or

nullOptional

include_all_targets_as_attendeesany ofOptionalDefault: false

booleanOptional

or

nullOptional

is_calendar_reschedulebooleanOptionalDefault: false

is_calendar_cancellationbooleanOptionalDefault: false

meeting_uidany ofOptional

stringOptional

or

nullOptional

meeting_sequenceany ofOptional

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

/api/templates/{template_id}

HTTPcURLJavaScriptPython

PUT /api/templates/{template_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 650

{
  "name": "text",
  "subject": "text",
  "body_html": "text",
  "body_text": "text",
  "attachments": [
    {}
  ],
  "calendar_enabled": true,
  "meeting_summary": "text",
  "organizer_cn": "text",
  "organizer_email": "[e-mail]",
  "attendees": [
    {
      "cn": "text",
      "email": "[e-mail]"
    }
  ],
  "disable_forwarding": true,
  "calendar_priority": 1,
  "calendar_categories": [
    "text"
  ],
  "calendar_private": true,
  "meeting_begin": "text",
  "meeting_end": "text",
  "meeting_provider": "none",
  "meeting_url": "text",
  "meeting_tz": "text",
  "location": "text",
  "allow_responses": true,
  "include_all_targets_as_attendees": false,
  "is_calendar_reschedule": false,
  "is_calendar_cancellation": false,
  "meeting_uid": "text",
  "meeting_sequence": 1
}

{
  "id": 1,
  "name": "text",
  "subject": "text",
  "body_html": "text",
  "body_text": "text",
  "attachments": [
    {
      "id": 1,
      "filename": "text",
      "mime_type": "text",
      "size": 1
    }
  ],
  "attachments_count": 0,
  "calendar_attachments_count": 0,
  "calendar_enabled": false,
  "meeting_summary": "text",
  "organizer_cn": "text",
  "organizer_email": "[e-mail]",
  "attendees": [
    {
      "cn": "text",
      "email": "[e-mail]"
    }
  ],
  "disable_forwarding": false,
  "calendar_priority": 2,
  "calendar_categories": [
    "text"
  ],
  "calendar_private": true,
  "meeting_begin": "text",
  "meeting_end": "text",
  "meeting_provider": "none",
  "meeting_url": "text",
  "meeting_tz": "text",
  "location": "text",
  "allow_responses": false,
  "include_all_targets_as_attendees": false,
  "is_calendar_reschedule": false,
  "is_calendar_cancellation": false,
  "meeting_uid": "text",
  "meeting_sequence": 1
}

Delete Template

delete

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

template_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/api/templates/{template_id}

HTTPcURLJavaScriptPython

DELETE /api/templates/{template_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

List Template Attachments

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

template_idintegerRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/api/templates/{template_id}/attachments

HTTPcURLJavaScriptPython

GET /api/templates/{template_id}/attachments HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": 1,
    "filename": "text",
    "mime_type": "text",
    "size": 1
  }
]

Upload Template Attachments

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

template_idintegerRequired

Body

multipart/form-data

filesstring · binary[]Required

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/api/templates/{template_id}/attachments

HTTPcURLJavaScriptPython

POST /api/templates/{template_id}/attachments HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 20

{
  "files": [
    "binary"
  ]
}

[
  {
    "id": 1,
    "filename": "text",
    "mime_type": "text",
    "size": 1
  }
]

Delete Template Attachment

delete

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

template_idintegerRequired

attachment_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/api/templates/{template_id}/attachments/{attachment_id}

HTTPcURLJavaScriptPython

DELETE /api/templates/{template_id}/attachments/{attachment_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

List Template Calendar Attachments

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

template_idintegerRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/api/templates/{template_id}/calendar_attachments

HTTPcURLJavaScriptPython

GET /api/templates/{template_id}/calendar_attachments HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": 1,
    "filename": "text",
    "mime_type": "text",
    "size": 1
  }
]

Upload Template Calendar Attachments

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

template_idintegerRequired

Body

multipart/form-data

filesstring · binary[]Required

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/api/templates/{template_id}/calendar_attachments

HTTPcURLJavaScriptPython

POST /api/templates/{template_id}/calendar_attachments HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 20

{
  "files": [
    "binary"
  ]
}

[
  {
    "id": 1,
    "filename": "text",
    "mime_type": "text",
    "size": 1
  }
]

Delete Template Calendar Attachment

delete

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

template_idintegerRequired

attachment_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/api/templates/{template_id}/calendar_attachments/{attachment_id}

HTTPcURLJavaScriptPython

DELETE /api/templates/{template_id}/calendar_attachments/{attachment_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Duplicate Template

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

template_idintegerRequired

Body

application/json

namestringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/api/templates/{template_id}/duplicate

HTTPcURLJavaScriptPython

POST /api/templates/{template_id}/duplicate HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": 1,
  "name": "text",
  "subject": "text",
  "body_html": "text",
  "body_text": "text",
  "attachments": [
    {
      "id": 1,
      "filename": "text",
      "mime_type": "text",
      "size": 1
    }
  ],
  "attachments_count": 0,
  "calendar_attachments_count": 0,
  "calendar_enabled": false,
  "meeting_summary": "text",
  "organizer_cn": "text",
  "organizer_email": "[e-mail]",
  "attendees": [
    {
      "cn": "text",
      "email": "[e-mail]"
    }
  ],
  "disable_forwarding": false,
  "calendar_priority": 2,
  "calendar_categories": [
    "text"
  ],
  "calendar_private": true,
  "meeting_begin": "text",
  "meeting_end": "text",
  "meeting_provider": "none",
  "meeting_url": "text",
  "meeting_tz": "text",
  "location": "text",
  "allow_responses": false,
  "include_all_targets_as_attendees": false,
  "is_calendar_reschedule": false,
  "is_calendar_cancellation": false,
  "meeting_uid": "text",
  "meeting_sequence": 1
}