CM.com

CM.com Template API

The Template API from CM.com — 5 operation(s) for template.

Documentation GitHub OpenAPI

Operations 11

GET /bulkemail/v1.0/accounts/{accountID}/templates Get all templates for an account #

POST /bulkemail/v1.0/accounts/{accountID}/templates Create a template #

GET /bulkemail/v1.0/accounts/{accountID}/templates/{templateID} Get a specific template #

PUT /bulkemail/v1.0/accounts/{accountID}/templates/{templateID} Update a template #

DELETE /bulkemail/v1.0/accounts/{accountID}/templates/{templateID} Delete a template #

GET /bulkemail/v1.0/demotemplates Get all demo templates #

GET /templates Get all templates #

POST /templates Create template #

GET /templates/{id} Get template #

PUT /templates/{id} Update template #

DELETE /templates/{id} Delete template #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/cm-com:cm-com-template-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Cm Com Template API
  version: '1.0'
  description: 'Operations tagged Template across 2 of this provider''s published API definitions: cm-com-mobile-marketing-cloud-email-campaigns-v1-openapi.yml, cm-com-sign-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://api.cm.com
- url: https://api.cm.com/sign/v1
- url: https://api.cm.com/sign-sandbox/v1
tags:
- name: Template
paths:
  /bulkemail/v1.0/accounts/{accountID}/templates:
    get:
      tags:
      - Template
      summary: Get all templates for an account
      operationId: Template_GetTemplatesAsync
      parameters:
      - name: accountID
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: skip
        in: query
        description: ''
        required: false
        schema:
          type: integer
          format: int32
      - name: take
        in: query
        description: ''
        required: false
        schema:
          type: integer
          format: int32
      - name: includeHtmlBody
        in: query
        description: ''
        required: false
        schema:
          type: boolean
      - name: includeTextBody
        in: query
        description: ''
        required: false
        schema:
          type: boolean
      - name: includeJson
        in: query
        description: ''
        required: false
        schema:
          type: boolean
      - name: filter
        in: query
        description: ''
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
    post:
      tags:
      - Template
      summary: Create a template
      operationId: Template_AddTemplateAsync
      parameters:
      - name: accountID
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        $ref: '#/components/requestBodies/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
      responses:
        '201':
          description: Template created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
            text/json:
              schema:
                $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
            text/xml:
              schema:
                $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
    servers:
    - url: http://api.cm.com
  /bulkemail/v1.0/accounts/{accountID}/templates/{templateID}:
    get:
      tags:
      - Template
      summary: Get a specific template
      operationId: Template_GetTemplateAsync
      parameters:
      - name: accountID
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: templateID
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: includeHtmlBody
        in: query
        description: ''
        required: false
        schema:
          type: boolean
      - name: includeTextBody
        in: query
        description: ''
        required: false
        schema:
          type: boolean
      - name: includeJson
        in: query
        description: ''
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
            text/json:
              schema:
                $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
            text/xml:
              schema:
                $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
    put:
      tags:
      - Template
      summary: Update a template
      operationId: Template_UpdateTemplateAsync
      parameters:
      - name: accountID
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: templateID
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        $ref: '#/components/requestBodies/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
            text/json:
              schema:
                $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
            text/xml:
              schema:
                $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
    delete:
      tags:
      - Template
      summary: Delete a template
      operationId: Template_DeleteTemplateAsync
      parameters:
      - name: accountID
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: templateID
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
    servers:
    - url: http://api.cm.com
  /bulkemail/v1.0/demotemplates:
    get:
      tags:
      - Template
      summary: Get all demo templates
      operationId: Template_GetDemoTemplatesAsync
      parameters:
      - name: skip
        in: query
        description: ''
        required: false
        schema:
          type: integer
          format: int32
      - name: take
        in: query
        description: ''
        required: false
        schema:
          type: integer
          format: int32
      - name: includeHtmlBody
        in: query
        description: ''
        required: false
        schema:
          type: boolean
      - name: includeTextBody
        in: query
        description: ''
        required: false
        schema:
          type: boolean
      - name: includeJson
        in: query
        description: ''
        required: false
        schema:
          type: boolean
      - name: filter
        in: query
        description: ''
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
    servers:
    - url: http://api.cm.com
  /templates:
    get:
      parameters:
      - in: query
        name: page
        description: The page of paginated templates to fetch. If not provided, gets the first page.
        schema:
          type:
          - integer
          - 'null'
          default: 1
          examples:
          - 1
      - in: query
        name: sortBy
        description: "The template field to sort the templates by, order depends on the 'order' parameter.\n  * lastUsedAt - The date the template was last used at.\n  * name - The name of the template.\n"
        schema:
          type:
          - string
          - 'null'
          default: lastUsedAt
          enum:
          - lastUsedAt
          - name
      - in: query
        name: order
        description: "The order to sort the templates by, depending on the 'sortBy' parameter.\n  * asc - Ascending. From A to Z of the name, or least recently used to most recently used.\n  * desc - Descending. From Z to A of the name, or most recently used to least recently used.\n"
        schema:
          type:
          - string
          - 'null'
          default: asc
          enum:
          - asc
          - desc
      - in: query
        name: perPage
        description: Number of templates to show in the response. If not provided, below 1, or above 100, will be set to 10.
        schema:
          type:
          - integer
          - 'null'
          default: 10
          examples:
          - 10
      - in: query
        name: search
        description: Filter the templates if their name contains the search text.
        schema:
          type:
          - string
          - 'null'
          examples:
          - HR Template
      operationId: list_templates
      summary: Get all templates
      description: Retrieve a paginated response of all templates.
      tags:
      - Template
      responses:
        '200':
          description: Templates have been retrieved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                    description: Total number of templates retrieved.
                    examples:
                    - 1
                  perPage:
                    type: integer
                    description: Maximum number of templates to be shown in the data field. Can be set in the query parameter.
                    examples:
                    - 10
                  currentPage:
                    type: integer
                    description: The current page of templates being returned.
                    examples:
                    - 1
                  lastPage:
                    type: integer
                    description: The number of the last page containing templates.
                    examples:
                    - 1
                  from:
                    type: integer
                    description: The index of the first template in the current page.
                    examples:
                    - 1
                  to:
                    type: integer
                    description: The index of the last template in the current page.
                    examples:
                    - 1
                  data:
                    type: array
                    description: The template objects with their data. Quantity returned depends on the 'perPage' parameter.
                    items:
                      $ref: '#/components/schemas/Template'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - JWT: []
    post:
      operationId: create_template
      summary: Create template
      description: Create a new template.
      tags:
      - Template
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTemplate'
      responses:
        '201':
          description: The template has been created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - JWT: []
    servers:
    - url: https://api.cm.com/sign/v1
    - url: https://api.cm.com/sign-sandbox/v1
  /templates/{id}:
    parameters:
    - in: path
      name: id
      description: A unique uuid string that identifies a template.
      required: true
      example: 6f8d0a9d-b85c-4c3f-9e69-5699f1e00f49
      schema:
        type: string
        format: uuid
    get:
      operationId: get_template
      summary: Get template
      description: Get a specific template.
      tags:
      - Template
      responses:
        '200':
          description: The template has been retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - JWT: []
    put:
      operationId: replace_template
      summary: Update template
      description: Update a specific template.
      tags:
      - Template
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTemplate'
      responses:
        '200':
          description: The template has been updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - JWT: []
    delete:
      operationId: delete_template
      summary: Delete template
      description: Delete a specific template.
      tags:
      - Template
      responses:
        '200':
          description: The template has been deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - JWT: []
    servers:
    - url: https://api.cm.com/sign/v1
    - url: https://api.cm.com/sign-sandbox/v1
components:
  schemas:
    CM.Tooling.BulkEmail.Api.Models.ApiTemplate:
      type: object
      properties:
        ID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        AccountID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        Name:
          type: string
        Description:
          type: string
        HtmlBody:
          type: string
        TextBody:
          type: string
        Json:
          type: string
        MergeFields:
          $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiMergeFields'
        TemplateEditorType:
          format: int32
          enum:
          - 1
          - 2
          type: integer
        CreatedOn:
          format: date-time
          type: string
        CreatedOnUtc:
          format: date-time
          type: string
        ModifiedOn:
          format: date-time
          type: string
        ModifiedOnUtc:
          format: date-time
          type: string
        DeletedOn:
          format: date-time
          type: string
        DeletedOnUtc:
          format: date-time
          type: string
    CM.Tooling.BulkEmail.Api.Models.ApiMergeTag:
      type: object
      properties:
        Name:
          type: string
        Value:
          type: string
        Mapping:
          type: string
    CM.Tooling.BulkEmail.Api.Models.ApiSpecialLink:
      type: object
      properties:
        Type:
          type: string
        Label:
          type: string
        Link:
          type: string
        Mapping:
          type: string
        Tag:
          type: string
    CM.Tooling.BulkEmail.Api.Models.ApiMergeFields:
      type: object
      properties:
        MergeTags:
          type: array
          items:
            $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiMergeTag'
        SpecialLinks:
          type: array
          items:
            $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiSpecialLink'
    FileReference:
      type: string
      format: uuid
      description: A unique reference number for this file.
      examples:
      - 8d817359-7eb8-4b6e-9030-17ac286b7dc0
    FieldLocation:
      type: object
      properties:
        range:
          type: string
          pattern: ^\d+(-\d+)?$
          maxLength: 64
          description: The page number within the PDF that this field occupies (e.g. `1`), or range for a initials field (e.g. `1-3`).
          examples:
          - '1'
        x:
          type: number
          format: float
          description: X position of the field in points.
        y:
          type: number
          format: float
          description: Y position of the field in points.
        width:
          type: number
          format: float
          description: Width of the field in points.
        height:
          type: number
          format: float
          description: Height of the field in points.
    CreateTemplate:
      type: object
      properties:
        name:
          type: string
          description: Name of the template.
          maxLength: 255
          examples:
          - Contract Template
        files:
          type: array
          items:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/FileReference'
        attachments:
          type: array
          items:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/FileReference'
        invitees:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: The placeholder name of the recipient.
                examples:
                - Recipient
        fields:
          type: array
          items:
            type: object
            properties:
              type:
                $ref: '#/components/schemas/FieldType'
              required:
                type: boolean
                description: Boolean for if the field is required to be filled by the invitee.
                examples:
                - true
              value:
                type:
                - string
                - 'null'
                description: The value of the field, if the type is 'label'.
                maxLength: 255
                examples:
                - Salary
              file:
                type:
                - integer
                - 'null'
                description: The index of the file in this request to link the field to, starting from 0.
                examples:
                - 0
              invitee:
                type: integer
                description: The index of the invitee in this request to link the field to, starting from 0.
                examples:
                - 0
              locations:
                type: array
                items:
                  $ref: '#/components/schemas/FieldLocation'
            required:
            - type
            - required
            - invitee
      required:
      - name
    ErrorResponse:
      title: Error Response
      type: object
      properties:
        status:
          type: integer
          format: int32
          description: Response status code, should match HTTP error code
        message:
          type: string
          description: High level description of the error that occurred. This description, when present, can be shown to the end user. It might describe that the system is not available, or that an unexpected error occurred. In test mode, the API will return more information (targeted at the developer) here than in production mode.
    FieldType:
      type: string
      description: The type of field for the invitee.
      enum:
      - signature
      - signatureDate
      - initials
      - text
      - textarea
      - label
      - checkbox
      - radio
      - stamp
      examples:
      - signature
    Template:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique ID of the template.
          examples:
          - f3ab4c4b-4276-46cc-bba6-d575696454ad
        name:
          type: string
          description: Name of the template.
          examples:
          - Contract Template
        files:
          type: array
          description: Files linked to the template.
          items:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/FileReference'
              name:
                type: string
                description: Original name of the file without extension.
                examples:
                - Template Agreement
        attachments:
          type: array
          description: Attachments linked to the template.
          items:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/FileReference'
              name:
                type: string
                description: Original name of the attachment without extension.
                examples:
                - Employee Handbook
        fields:
          type: array
          description: Fields that will be linked to the file and invitee when applying to a dossier.
          items:
            type: object
            properties:
              type:
                $ref: '#/components/schemas/FieldType'
              required:
                type: boolean
                description: Boolean for if the field is required to be filled by the invitee.
                examples:
                - true
              value:
                type: string
                description: The value of the field, if the type is 'label'.
                examples:
                - Salary
              file:
                type: integer
                description: The index of the file when creating the dossier to link this field to, starting from 0.
                examples:
                - 0
              invitee:
                type: integer
                description: The index of the invitee when creating the dossier to link this field to, starting from 0.
                examples:
                - 0
              locations:
                type: array
                items:
                  $ref: '#/components/schemas/FieldLocation'
        lastUsedAt:
          type: string
          format: date-time
          description: The date the template was last applied on a dossier, in ISO 8601 format.
          examples:
          - '2026-01-01T00:00:00+00:00'
        updatedAt:
          type: string
          format: date-time
          description: The date the template was last updated, in ISO 8601 format.
          examples:
          - '2026-01-01T00:00:00+00:00'
        createdAt:
          type: string
          format: date-time
          description: The date the template was created, in ISO 8601 format.
          examples:
          - '2026-01-01T00:00:00+00:00'
  requestBodies:
    CM.Tooling.BulkEmail.Api.Models.ApiTemplate:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
        text/json:
          schema:
            $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
        text/xml:
          schema:
            $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
        application/x-www-form-urlencoded:
          schema:
            $ref: '#/components/schemas/CM.Tooling.BulkEmail.Api.Models.ApiTemplate'
      required: true
  responses:
    NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'In order to authenticate you need to use your credentials to generate a JWT Bearer token. The [JWT token](https://jwt.io/introduction/) has to be generated using the `HS256` algorithm and your credentials. This JWT has to contain the following attributes: `iat`, `nbf`, `exp`  in the payload, as well as the attribute `kid` in the header of the JWT. This `kid` attribute needs to contain the Key Id of your credentials.


        The generated token needs to be passed via the HTTP Authorization header like:


        ```

        Authorization: Bearer GENERATED_TOKEN_HERE

        ```


        There are many libraries available for different programming languages that can help you to generate a JWT. See the Libraries tab on [https://jwt.io](https://jwt.io)

        '
x-refined-from:
- cm-com-mobile-marketing-cloud-email-campaigns-v1-openapi.yml
- cm-com-sign-v1-openapi.yml