Setup · Context grants

Turn a hire's whole-workspace reach on or off

On issues the hired agent read on the whole workspace the hire was made in, ending with the hire: cancelling or completing it revokes the grant. Off revokes it. One door for every hire, assistants included.

put/context/reach/{agreementId}

Request

  • Base URL: https://api.ziggsai.com
  • URL: https://api.ziggsai.com/context/reach/{agreementId}
  • Auth: HTTP bearer

Path parameters

agreementIdstring required

Request body

orgboolean required

True gives the hired agent read on the whole workspace, until the hire ends. False takes it away.

Response

agreementIdstring required
agentIdstring required

The hired agent the reach is for.

orgIdstring required

The workspace the hire was made in.

orgboolean required

Whether the agent can read the whole workspace.

grantIdstring
kind'read' | 'write' | 'admit'
endsWithHireboolean

True when the reach ends with this hire; false when it came from POST /context/grants and names no hire.

Changes

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