Send Proposal Sign-in Code

POST

api

public

proposals

{proposalId}

code

Send Proposal Sign-in Code

curl --request POST \
  --url https://spaces.nexudus.com/api/public/proposals/{proposalId}/login/code \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/public/proposals/{proposalId}/login/code"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/public/proposals/{proposalId}/login/code', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CodeSent": true,
  "Email": "<string>"
}

When Proposal Login answers mustSignIn: true, the proposal is for a customer who already has an account and is not signed in. This endpoint emails that customer the SignInCode email: a six-digit code to send back to Proposal Login, and a link that signs them in and brings them back to returnUrl. See Sign-in Codes. The code goes to the address on the proposal’s customer account, never to an address the caller chooses.

Authentication

No authentication required. At most 5 code emails go to one account in 15 minutes.

Path Parameters

string

required

The unique string identifier (GUID) of the proposal.

Query Parameters

string

default:"/"

The page the email’s link brings the customer back to, normally the proposal page itself. Only a path on the portal is used; anything else falls back to /.

Response

boolean

true when the email went out.

string

The address it went to, masked (j•••@example.com), so the page can say where to look without disclosing whose proposal it is.

Errors

Message	When
`NO_ACCOUNT`	The customer has no account yet. Proposal Login creates it and signs them in, so there is nothing to prove
`TWO_FACTOR_REQUIRED`	The account has two-factor authentication: a code cannot open a session there. Send the customer to the sign-in page
`TOO_MANY_CODES`	More than 5 code emails in 15 minutes. No email goes out and the last code sent keeps working
`PROPOSAL_EXPIRED`, `PROPOSAL_REJECTED`	As for Proposal Login

A 404 comes from a proposal that is not this location’s, or from a platform version without codes. The portal treats both, and TWO_FACTOR_REQUIRED, by sending the customer to the sign-in page.

Examples

POST /api/public/proposals/abc123-def456/login/code?returnUrl=%2Fhoxton%2Fcheckout%2Fproposal%3Fproposal_id%3Dabc123-def456

{
  "CodeSent": true,
  "Email": "j•••@example.com"
}

TypeScript Integration

import { useProposalData } from '@/views/checkout/useProposalData'

const { loginWithProposal, sendLoginCode, loginWithCode, redirectToSignIn } = useProposalData()

if ((await loginWithProposal()) === 'mustSignIn') {
  const sent = await sendLoginCode() // null: no code possible, use the sign-in page
  if (!sent) redirectToSignIn()
  // ...ask for the code sent to sent.email, then:
  await loginWithCode(code)
}

Send Proposal Sign-in Code

curl --request POST \
  --url https://spaces.nexudus.com/api/public/proposals/{proposalId}/login/code \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/public/proposals/{proposalId}/login/code"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/public/proposals/{proposalId}/login/code', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CodeSent": true,
  "Email": "<string>"
}

​Send Proposal Sign-in Code

​Authentication

​Path Parameters

​Query Parameters

​Response

​Errors

​Examples

​TypeScript Integration

Authentication

Path Parameters

Query Parameters

Response

Errors

Examples

TypeScript Integration