Skip to main content

Input fields

number : String! required

Collection process number to pause.

pauseLength : Int

Number of calendar days to pause the collection process, with a minimum of 1 day. The current maximum is read from the dynamic setting COLLECTION_PROCESS_MANUAL_PAUSE_MAX_LENGTH_DAYS; if unset, the deployed client default applies (shared default: 90 days). If omitted or null, the process remains paused until manually resumed.

pauseStartAt : DateTime! required

Start datetime for pause.

reason : String! required

Reason for pausing collection process.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "number": "player-system-shoulder-home-sound", "pauseLength": 62, "pauseStartAt": "1990-02-22T10:45:31.069784+00:00", "reason": "indeed-adult-common-employee-teach" }