Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/templates HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"name": "text",
"type": "EnrollmentProcessing",
"default": true,
"content": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"content": "text",
"default": true,
"type": "text",
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
Bad Request
Forbidden
Internal Server Error
No content
PUT /public/v1/program/programs/{programId}/templates/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"name": "text",
"default": true,
"content": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"content": "text",
"default": true,
"type": "text",
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
GET /public/v1/program/programs/{programId}/templates HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {},
"updated": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"content": "text",
"default": true,
"type": "text",
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
"[Circular Reference]"
]
}
}
]
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/program/programs/{programId}/templates/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
The Program Template Object provides functionality for templates to be made and automatically delivered once a set of rules based on type is met. This enables the client to know what is happening with their order and if anything is needed of them.
This object contains the following attributes:
id
string
The business identifier of the program template.
href
string
The resource URI of the terms variant.
type
string
Indicates the type. Allowed values are:
certificateActivate
certificatePending
certificateExpired
enrollmentProcessing
enrollmentQuerying
enrollmentCompleted
name
string
The name of the template.
content
string
The content of the template.
default
boolean
Each program has 3 defaults automatically generated when the program is created.
Each automatically created template will include a default system message that the client account must update.
Defaults cannot be deleted, while non-defaults can be deleted.
program
Represents the program to which the term item belongs.
audit
(Read-only) Represents the audit object.
OK
Not Found
GET /public/v1/program/programs/{programId}/templates/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"content": "text",
"default": true,
"type": "text",
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}