Skip to main content
POST
/
api
/
public
/
proposals
/
{proposalId}
/
esign
/
start
{
  "Id": 123,
  "Name": "<string>"
}

​
Start E-Sign

Initiates the electronic signature flow for a proposal. Returns an object containing the signature request identifier that can be used to launch the e-sign UI.

​
Authentication

No authentication required — proposals are accessed via their unique identifier.

​
Path Parameters

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

​
Request Body

No request body required.

​
Response

​
Id
number
required
Signature request identifier.
​
Name
string
required
Name of the signature request.

​
Examples

​
Start e-sign

POST /api/public/proposals/abc123-def456/esign/start

{
  "Id": 42,
  "Name": "Membership Agreement"
}

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const result = await httpClient.post(endpoints.proposals.esign.start('abc123-def456').url)