Skip to main content
PUT
Edit a program

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

program_id
integer
required

ID of the program to update in the authenticated organization.

Body

application/json

Only the name, prefix, counter, and link_id properties are used to update the program.

name
string
required

Required program name, at least three characters.

Minimum string length: 3
Example:

"Child Sponsorship"

prefix
string

Recipient identifier prefix. Omitted or empty values clear the prefix.

Example:

"CS"

counter
number

Numeric recipient counter. Omitted or empty values reset it to zero.

Example:

12

Optional parent program ID within the organization. A nonzero value inherits the parent's recipient form; zero or omission keeps the existing parent.

Example:

7

Response

Program updated

message
string
Example:

"Program info successfully updated."