Skip to main content
PATCH
Rename a program

Authorizations

X-HYS-API-Key
string
header
required

Gratona API key sent with the compatibility header X-HYS-API-Key.

Path Parameters

program_id
integer<int64>
required

The tenant-owned program to rename. The controller verifies that this ID belongs to the authenticated user's client.

Example:

3541

Body

application/json
name
string
required

The new program display name. Validation rule: required|string|min:3|max:255.

Required string length: 3 - 255
Example:

"Abode Mission Support Fund"

Response

Program renamed successfully without changing any other program attributes.

message
string
Example:

"Program name successfully updated."

program
object