Change an episode’s workflow status, outline or recording over REST
Three routes: PUT /benecaster-podcast-workflow/v1/shows/{show_id}/episodes/{episode_id}/workflow-status, PUT …/outline and PUT …/recording.
Access. The same permission and per-show checks as Read the Podcast Workflow Workbench over REST: benecaster_rest_permission_admin, then 404 benecaster_podcast_workflow_show_not_found, 403 benecaster_podcast_workflow_off_for_show, 404 benecaster_podcast_workflow_episode_not_found (trashed or missing) and 409 benecaster_podcast_workflow_other_show for another show’s episode, which is never changed. Each route answers 200 with the episode’s refreshed canvas, as GET …/workbench does.
PUT …/workflow-statussends{ status }:draft,revieworapproved. Anything else is400 benecaster_podcast_workflow_invalid_status. An episode that is scheduled or published takes its status from the episode:409 benecaster_podcast_workflow_status_from_episode. A change fires the status hooks in Run your own code when an episode’s workflow status, recording or outline changes in Podcast Workflow.PUT …/outlinesends{ outline, final }: the outline as plain text (a blank line starts a paragraph, a single line break is kept) andfinalastrueorfalse. It is stored as<p>paragraphs in_benecaster_workflow_outline. Over 100,000 characters is400 benecaster_podcast_workflow_outline_too_long; a missing or non-boolean field is400 benecaster_podcast_workflow_invalid_field.PUT …/recordingsends{ complete }astrueorfalse(else400 benecaster_podcast_workflow_invalid_field).
Code
<?php
$request = new WP_REST_Request( 'PUT', '/benecaster-podcast-workflow/v1/shows/42/episodes/1234/workflow-status' );
$request->set_body_params( [ 'status' => 'review' ] );
$canvas = rest_do_request( $request )->get_data(); // $canvas['workflow']['status'] === 'review'
Need this built rather than just documented? See our services →