SupDesk API
PATCH/v1/beta/programs/{id}

Update a beta program

Updates the name, description, or status of a beta program. Supply any fields you want to change; status can be draft, active, or closed. The response contains the updated program.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
idstringrequired
The identifier of the beta program to update.

Beta program fields to update; all listed fields can be omitted.

namestringoptional
The name of the beta program.
descriptionstringoptional
A description of the beta program.
statusstringoptional
The program status: draft, active, or closed.
Allowed:draftactiveclosed

3 status codes
200Returns the updated beta program in the `data` object.
dataobjectoptional
401Returned when the request is not authenticated.
errorobjectoptional
404Returned when the beta program does not exist.
errorobjectoptional

Error handling

A 401 is returned when the request is not authenticated, and a 404 is returned when the program does not exist. The id path parameter must identify an existing beta program. In the body, status must be draft, active, or closed when supplied.