Create named lists
/named-listsMake a named list holding the entries given, as version 1. Every entry is checked against the list's kind, and refused with every reason if it fails.
Permissions
settings:updateRequires the `update` action on `settings` for the supplied runtime context
Request body
This body is a tagged shape: type is always "NlstCmdCreate". Send it; more variants can be added, and a caller that switches on it keeps working when they are.
typetype = "NlstCmdCreate"domainstringrequiredThe area the list is for, as ruleAreaId names it.
The tenant that owns the list. Absent for the caller's own tenant.
typeThe tenant that owns a rule policy or a named list: the platform, or an enterprise, a marketplace or a merchant.
enterpriseIdEntIdrequiredIdentifier of an enterprise.
Example ent_9f2Kd8QpLzXw
The tenant that owns a rule policy or a named list: the platform, or an enterprise, a marketplace or a merchant.
marketplaceIdMktpIdrequiredIdentifier of a marketplace.
Example mktp_9f2Kd8QpLzXw
The tenant that owns a rule policy or a named list: the platform, or an enterprise, a marketplace or a merchant.
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
The platform, which no enterprise, marketplace or merchant bounds.
The platform, which no enterprise, marketplace or merchant bounds.
namestringrequiredExample Ada Lovelace
kindstringrequiredThe kind of entry it holds, one of the area's listKinds.
descriptionstringentriesarray of stringcurl -X POST https://api.tst.au.apgpay.dev/named-lists \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "NlstCmdCreate",
"domain": "string",
"owner": {
"type": "SpolOwnerEnterprise",
"enterpriseId": "ent_9f2Kd8QpLzXw"
},
"name": "Ada Lovelace",
"kind": "string",
"description": "string",
"entries": [
"string"
]
}'Responses
The response is a tagged shape: type is always "NlstCreateRspAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.
typetype = "NlstCreateRspAttributes"The resource that was created.
typeenumrequiredNlstViewAttributesnamedListIdNlstIdrequiredIdentifier of a named list.
Example nlst_9f2Kd8QpLzXw
namestringrequiredThe list's name, which is unique among its owner's lists of the same area.
Example Ada Lovelace
domainstringrequiredThe area the list is for, as ruleAreaId names it.
typeThe tenant that owns a rule policy or a named list: the platform, or an enterprise, a marketplace or a merchant.
enterpriseIdEntIdrequiredIdentifier of an enterprise.
Example ent_9f2Kd8QpLzXw
The tenant that owns a rule policy or a named list: the platform, or an enterprise, a marketplace or a merchant.
marketplaceIdMktpIdrequiredIdentifier of a marketplace.
Example mktp_9f2Kd8QpLzXw
The tenant that owns a rule policy or a named list: the platform, or an enterprise, a marketplace or a merchant.
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
The platform, which no enterprise, marketplace or merchant bounds.
The platform, which no enterprise, marketplace or merchant bounds.
kindstringrequiredThe kind of entry it holds, one of its area's listKinds. Each entry is checked to be a member of the kind.
descriptionstringversioninteger (int32)requiredThe current version, which an edit names as expectedVersion.
Example 1250
createdAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
createdBystringrequiredWho made the list, as a screen shows them.
typeA person, by the name the identity records hold for them.
idstringrequiredThe key the change was recorded under: an IAM user's id (user_), or a legacy staff member's key (staff_).
displayNamestringrequiredExample Ada Lovelace
One of the platform's own staff, as a tenant is shown them: by the platform's name and not their own. The platform's own callers are shown the person.
idstringrequiredThe key the change was recorded under.
namestringrequiredAlways Platform.
Example Ada Lovelace
A process that records itself, such as a data migration that brought configuration in, or the system that approves what it imports.
idstringrequiredThe key the change was recorded under, which is the process's own name.
namestringrequiredExample Ada Lovelace
A key no record names a person by now: a user since removed or with no name, or a legacy staff member's key that no IAM user's address was tied to when they acted.
idstringrequiredThe key the change was recorded under.
updatedAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
retiredAtstring (date-time)When the list was retired. Absent for one that is not.
Example 2026-08-19T04:21:07Z
permittedActionsarray of NlstPermittedActionWhat the caller may do to the list now. Empty where the caller only reads it, or it belongs to a tenant above the caller.
EditUnknown{
"type": "NlstCreateRspAttributes",
"created": {
"type": "NlstViewAttributes",
"namedListId": "nlst_9f2Kd8QpLzXw",
"name": "Ada Lovelace",
"domain": "string",
"owner": {
"type": "SpolOwnerEnterprise",
"enterpriseId": "ent_9f2Kd8QpLzXw"
},
"kind": "string",
"description": "string",
"version": 1250,
"createdAt": "2026-08-19T04:21:07Z",
"createdBy": "string",
"createdByActor": {
"type": "SpolActorPerson",
"id": "string",
"displayName": "Ada Lovelace"
},
"updatedAt": "2026-08-19T04:21:07Z",
"retiredAt": "2026-08-19T04:21:07Z",
"permittedActions": [
"Edit"
]
}
}Error responses
statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}