templates

Update a template

Changed on Jul 11, 2025

Updates the template details.

patch/{account}/templates/{template}

Request

Base URL
https://api.dnsimple.com/v2
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/dnsimple/apis/dnsimple-api/docs/:account/templates/:template/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

accountinteger required

The account id

templatestring required

The template id or short name

Request body

sidstring

namestring

descriptionstring

Example request

{
  "name": "Alpha",
  "sid": "alpha",
  "description": "This is an Alpha template."
}

Response

Successfully updated a template.

Example response

{
  "data": {
    "id": 1,
    "account_id": 1010,
    "name": "Alpha",
    "sid": "alpha",
    "description": "An alpha template.",
    "created_at": "2016-03-22T11:08:58Z",
    "updated_at": "2016-03-22T11:08:58Z"
  }
}

Changes

Jul 11, 2025v206780be0ef17 Revision changes
- info
  the request property became optional
- info
  the request property became optional
- info
  the response property became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property became required for the status
Jul 18, 2023v2c8591dcf8c29 Revision changes
- breaking
  the request property became required
- breaking
  the request property became required
- breaking
  the response property became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property became optional for the status

Operation history