Skip to main content
PUT
/
api
/
public
/
proposals
/
{proposalId}
/
login
{
  "file": 123,
  "accessToken": "<string>"
}

​
Proposal Login

Authenticates a user to access a specific proposal. Used when proposals require email verification before the recipient can view or accept them.

​
Authentication

No prior authentication required.

​
Path Parameters

​
proposalId
string
required
The unique string identifier (GUID) of the proposal.

​
Request Body

​
Email
string
required
Email address of the proposal recipient for verification.

​
Response

Returns the proposal file ID and an access token for subsequent proposal interactions.
​
file
number
required
The numeric identifier of the proposal file.
​
accessToken
string
required
A token used to authenticate further proposal actions (e.g. accepting the proposal). Exchanged for a full auth session via exchangeToken().

​
Examples

​
Login to view a proposal

PUT /api/public/proposals/abc123-def456/login
Content-Type: application/json

{
  "Email": "member@example.com"
}

​
TypeScript Integration

import endpoints from '@/api/endpoints'

await httpClient.put(endpoints.proposals.login('abc123-def456'), {
  Email: 'member@example.com',
})