Update Parameter Group

Update an existing parameter group

put

The parameter group ID is provided in the route.

Path parameters

idstringRequired

The ID of the parameter group to update.

Body

application/jsontext/jsonapplication/*+json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

labelstringOptional

The translatable label for the parameter group

Example: Customer Information

descriptionstring · nullableOptional

The optional description providing additional context for the parameter group

Example: Basic customer details and contact information

isDeletedbooleanOptional

Indicates whether the parameter group has been marked as deleted

Example: false

Responses

200

OK

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

put

/public/v1/helpdesk/parameter-groups/{id}

HTTPcURLJavaScriptPython

PUT /public/v1/helpdesk/parameter-groups/{id} HTTP/1.1
Host: api.s1.show
Content-Type: application/json
Accept: */*
Content-Length: 3678

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-03-30T20:13:00.997Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-03-30T20:13:00.997Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "at": "2026-03-30T20:13:00.997Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "label": "Customer Information",
  "description": "Basic customer details and contact information",
  "parameters": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-03-30T20:13:00.997Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-03-30T20:13:00.997Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "deleted": {
          "at": "2026-03-30T20:13:00.997Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1,
      "scope": "Form",
      "phase": "Request",
      "description": "Customer contact email address",
      "multiple": false,
      "externalId": "EXT-PARAM-123",
      "displayOrder": 1,
      "constraints": {
        "hidden": true,
        "readonly": true,
        "required": true,
        "capacity": {
          "min": 1,
          "max": 1
        },
        "visibility": "All"
      },
      "options": null,
      "type": "String",
      "statistics": {
        "cases": 1,
        "groups": 1,
        "forms": 1
      },
      "account": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active"
      },
      "isDeleted": true,
      "group": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-03-30T20:13:00.997Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-03-30T20:13:00.997Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "deleted": {
            "at": "2026-03-30T20:13:00.997Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "label": "Customer Information",
        "description": "Basic customer details and contact information",
        "parameters": [
          "[Circular Reference]"
        ],
        "account": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-03-30T20:13:00.997Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-03-30T20:13:00.997Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "technicalSupportEmail": "text",
          "website": "text",
          "description": "text",
          "groups": [
            {
              "id": "text",
              "name": "text",
              "revision": 1,
              "description": "text",
              "logo": "text",
              "isDefault": true
            }
          ],
          "eligibility": {
            "client": true,
            "partner": true
          },
          "defaultLanguageCode": "text"
        },
        "statistics": {
          "parameters": 1,
          "forms": 1
        },
        "isDeleted": false
      }
    }
  ],
  "account": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-03-30T20:13:00.997Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-03-30T20:13:00.997Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "revision": 1,
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    },
    "defaultLanguageCode": "text"
  },
  "statistics": {
    "parameters": 1,
    "forms": 1
  },
  "isDeleted": false
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-03-30T20:13:00.997Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-03-30T20:13:00.997Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "at": "2026-03-30T20:13:00.997Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "label": "Customer Information",
  "description": "Basic customer details and contact information",
  "parameters": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-03-30T20:13:00.997Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-03-30T20:13:00.997Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "deleted": {
          "at": "2026-03-30T20:13:00.997Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1,
      "scope": "Form",
      "phase": "Request",
      "description": "Customer contact email address",
      "multiple": false,
      "externalId": "EXT-PARAM-123",
      "displayOrder": 1,
      "constraints": {
        "hidden": true,
        "readonly": true,
        "required": true,
        "capacity": {
          "min": 1,
          "max": 1
        },
        "visibility": "All"
      },
      "options": null,
      "type": "String",
      "statistics": {
        "cases": 1,
        "groups": 1,
        "forms": 1
      },
      "account": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active"
      },
      "isDeleted": true,
      "group": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-03-30T20:13:00.997Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-03-30T20:13:00.997Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "deleted": {
            "at": "2026-03-30T20:13:00.997Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "label": "Customer Information",
        "description": "Basic customer details and contact information",
        "parameters": [
          "[Circular Reference]"
        ],
        "account": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-03-30T20:13:00.997Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-03-30T20:13:00.997Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "technicalSupportEmail": "text",
          "website": "text",
          "description": "text",
          "groups": [
            {
              "id": "text",
              "name": "text",
              "revision": 1,
              "description": "text",
              "logo": "text",
              "isDefault": true
            }
          ],
          "eligibility": {
            "client": true,
            "partner": true
          },
          "defaultLanguageCode": "text"
        },
        "statistics": {
          "parameters": 1,
          "forms": 1
        },
        "isDeleted": false
      }
    }
  ],
  "account": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-03-30T20:13:00.997Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-03-30T20:13:00.997Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "revision": 1,
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    },
    "defaultLanguageCode": "text"
  },
  "statistics": {
    "parameters": 1,
    "forms": 1
  },
  "isDeleted": false
}