Skip to navigation

Auto Build Deal Page

Build the deal page from the usual templates when it holds only the seeded description or an unedited auto-build. A page an analyst has edited is left alone unless force is set.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

group_idintegerRequired
deal_idintegerRequired

Query parameters

forcebooleanOptionalDefaults to false

Request

This endpoint expects a nullable object.
triggerstringOptional<=255 charactersDefaults to manual
settingsobject or nullOptional
Chart settings the scan deck resolved. Absent when the build was not triggered by a scan.

Response

Successful Response
statusenum
Allowed values:
room_idstring
templateslist of strings
content_hashstring or nullOptional
skip_reasonenum or nullOptional
Allowed values:
dropped_typeslist of stringsOptionalDefaults to []
skipped_key_findingsbooleanOptionalDefaults to false

Errors

422
Unprocessable Entity Error