Update template

Updates a notification template.

put

Updates template properties. Only provided fields will be modified.

Path parameters

idstringRequired

A notification template ID.

Body

application/jsontext/jsonapplication/*+json

namestringOptional

descriptionstring · nullableOptional

externalIdstring · nullableOptional

Responses

200

OK

application/json

Represents a reusable template that can be used to generate messages.

idstringOptional

namestringOptional

revisioninteger · int32Optional

descriptionstring · nullableOptional

Gets or sets the description of this template.

lastUsedstring · date-time · nullableOptional

Gets or sets the timestamp of when this template was last used to send a notification.

statusstringOptional

Gets or sets the current status of the template.

externalIdstring · nullableOptional

Gets or sets an external identifier for integration with external systems.

400

Bad Request

application/json

404

Not Found

application/json

put/public/v1/notifications/templates/{id}

HTTPcURLJavaScriptPython

PUT /public/v1/notifications/templates/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "name": "text",
  "description": "text",
  "category": {
    "id": "text"
  },
  "criteria": {
    "accountTypes": [
      "Client"
    ],
    "objectType": "Account",
    "filterCondition": "text",
    "recipients": {
      "selector": "text"
    }
  },
  "externalId": "text",
  "defaultVariant": {
    "id": "text"
  }
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-07-22T10:26:51.915Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-07-22T10:26:51.915Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "activated": {
      "at": "2026-07-22T10:26:51.915Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "at": "2026-07-22T10:26:51.915Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "disabled": {
      "at": "2026-07-22T10:26:51.915Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "revision": 1,
  "category": {
    "id": "text",
    "name": "text",
    "revision": 1,
    "description": "text",
    "lastUsed": "2026-07-22T10:26:51.915Z"
  },
  "criteria": {
    "accountTypes": [
      "text"
    ],
    "filterCondition": "text",
    "objectType": "text",
    "recipients": {
      "selector": "text"
    }
  },
  "defaultVariant": {
    "id": "text",
    "revision": 1,
    "default": true,
    "languageCode": "text",
    "status": "text"
  },
  "description": "text",
  "lastUsed": "2026-07-22T10:26:51.915Z",
  "owner": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "statistics": {
    "month": 1,
    "today": 1,
    "week": 1
  },
  "status": "text",
  "variants": [
    {
      "id": "text",
      "revision": 1,
      "default": true,
      "languageCode": "text",
      "status": "text"
    }
  ],
  "externalId": "text"
}