POST /api/builder/preview/{builder_id}/grant/
Start the preview process for a logged-in editor.
This is the only step that uses the editor's normal account login. It makes
sure the editor may read the requested builder before issuing a temporary
preview pass. The returned URL is then opened by the browser to continue
with :class:BuilderPreviewExchangeView.
Servers
- /
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
builder_id |
String | Yes |
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 |
|---|---|---|---|
path |
String | No |
Default value: "/" |
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.