POST /terminals/scheduleActions
Schedules a terminal action by specifying the action and the terminals that the action must be applied to.
The following restrictions apply:
- You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests.
- The maximum number of terminals in a request is 100. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests.
- If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again.
To make this request, your API credential must have the following role:
- Management API—Terminal actions read and write
Servers
- https://management-test.adyen.com/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
storeId |
String | No |
The unique ID of the store. If present, all terminals in the |
terminalIds[] |
Array | No |
A list of unique IDs of the terminals to apply the action to. You can extract the IDs from the GET |
actionDetails |
Object | No |
Information about the action to take. |
scheduledAt |
String | No |
The date and time when the action should happen. Format: RFC 3339, but without the Z before the time offset. For example, 2021-11-15T12:16:21+0100 The action is sent with the first maintenance call after the specified date and time in the time zone of the terminal. An empty value causes the action to be sent as soon as possible: at the next maintenance call. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.