Connect a supervised session to a Poppy site (poppy_connect)

post/v1/browser/session/{session_id}/poppy

Request

  • Base URL: https://api.roveapi.com
  • URL: https://api.roveapi.com/v1/browser/session/{session_id}/poppy
  • Auth: HTTP bearer

Request body

originstring required

The site, an https URL.

return_tostring

An https URL on the site to land on after the join.

page_idstring
scopesstring[]

With a stored approval: the scopes to use; [] connects signed out.

replace_company_cookiesboolean

Remove the profile's existing cookies and saved data for the site first (ask the person).

Response

Successful response

poppy_session_idstring required
state'guest_joined' | 'signing_in' | 'joined' | 'expired' | 'closed' | 'failed' | 'guest' | 'signed_in' | 'revoked' required
signed_inboolean required
cleanup'none' | 'pending' | 'done' | 'failed' required
requested_scopesstring[] required
granted_scopesstring[] required
sign_in_modesstring[] required
sign_in_modes_unsupportedstring[] required
sign_in_startingboolean required
refusals_head_seqinteger required
refusals_dropped_through_seqinteger required
ended_reason'agent_disconnected' | 'supervised_session_ended' | 'account_mismatch' | 'company_session_ended' | 'join_failed' | 'token_not_dpop_bound' | 'company_refused' | 'company_response_invalid' | 'document_invalid' | 'company_unavailable'
ended_detail'join_cookie_script_readable'
ended_atstring

ISO 8601 UTC instant.

nextstring required

What to do now, from the state and the latest sign-in outcome.

company_cookies_clearedinteger
company_storage_origins_clearedinteger
page_idstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.