Mark the offer as lost (declined). Returns the refreshed envelope.

curl --request POST \
  --url https://api.offerclub.io/v1.0/offers/{id}/mark-lost \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'

import requests

url = "https://api.offerclub.io/v1.0/offers/{id}/mark-lost"

payload = {}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.offerclub.io/v1.0/offers/{id}/mark-lost', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.offerclub.io/v1.0/offers/{id}/mark-lost",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.offerclub.io/v1.0/offers/{id}/mark-lost"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.offerclub.io/v1.0/offers/{id}/mark-lost")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.offerclub.io/v1.0/offers/{id}/mark-lost")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "publicId": "<string>",
  "offerNumber": "<string>",
  "status": "DRAFT",
  "title": "<string>",
  "subtitle": "<string>",
  "introduction": "<string>",
  "price": 123,
  "validUntil": "2023-11-07T05:31:56Z",
  "clientFirstName": "<string>",
  "clientLastName": "<string>",
  "clientEmail": "<string>",
  "clientPhone": "<string>",
  "clientCompanyName": "<string>",
  "sentToEmail": "<string>",
  "sentAt": "2023-11-07T05:31:56Z",
  "wonAt": "2023-11-07T05:31:56Z",
  "lostAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z",
  "acceptedByFirstName": "<string>",
  "acceptedByLastName": "<string>",
  "acceptedByEmail": "<string>",
  "acceptedByPhone": "<string>",
  "signatureFileId": "<string>",
  "declineReason": "NONE",
  "documentFileId": "<string>",
  "availableActions": {
    "canUpdate": true,
    "canDelete": true,
    "canSend": true,
    "canMarkWon": true,
    "canMarkLost": true,
    "canArchive": true,
    "canUnarchive": true,
    "canManagePaymentPlans": true,
    "canManageAssets": true
  },
  "publicUrl": "<string>",
  "signatureFileThumbnail": {
    "thumbnailWidth": 123,
    "thumbnailHeight": 123,
    "thumbnailUrl": "<string>",
    "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
  },
  "acceptedPaymentPlan": {
    "id": "<string>",
    "type": "UPFRONT",
    "installmentCount": 123,
    "computedSchedule": [
      {
        "position": 123,
        "source": "PERCENTAGE",
        "percentage": 123,
        "amount": 123,
        "dueDate": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "contactUser": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "role": "<string>",
    "avatarFileThumbnail": {
      "thumbnailWidth": 123,
      "thumbnailHeight": 123,
      "thumbnailUrl": "<string>",
      "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
    },
    "signatureFileThumbnail": {
      "thumbnailWidth": 123,
      "thumbnailHeight": 123,
      "thumbnailUrl": "<string>",
      "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
    }
  },
  "mainVideo": {
    "url": "<string>",
    "videoProvider": "YOUTUBE"
  },
  "callRecording": {
    "url": "<string>",
    "videoProvider": "YOUTUBE"
  },
  "paymentPlans": {
    "upfront": {
      "id": "<string>",
      "enabled": true,
      "computedSchedule": [
        {
          "position": 123,
          "source": "PERCENTAGE",
          "percentage": 123,
          "amount": 123,
          "dueDate": "2023-11-07T05:31:56Z"
        }
      ]
    },
    "split5050": {
      "id": "<string>",
      "enabled": true,
      "computedSchedule": [
        {
          "position": 123,
          "source": "PERCENTAGE",
          "percentage": 123,
          "amount": 123,
          "dueDate": "2023-11-07T05:31:56Z"
        }
      ]
    },
    "installments": {
      "items": [
        {
          "id": "<string>",
          "count": 3,
          "enabled": true,
          "computedSchedule": [
            {
              "position": 123,
              "source": "PERCENTAGE",
              "percentage": 123,
              "amount": 123,
              "dueDate": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ]
    },
    "custom": {
      "id": "<string>",
      "enabled": true,
      "computedSchedule": [
        {
          "position": 123,
          "source": "PERCENTAGE",
          "percentage": 123,
          "amount": 123,
          "dueDate": "2023-11-07T05:31:56Z"
        }
      ]
    }
  },
  "assets": {
    "faqs": {
      "isSnapshot": true,
      "enabled": true,
      "items": [
        {
          "sourceId": "<string>",
          "question": "<string>",
          "answer": "<string>",
          "position": 123
        }
      ]
    },
    "banner": {
      "isSnapshot": true,
      "enabled": true,
      "item": {
        "sourceId": "<string>",
        "name": "<string>",
        "title": "<string>",
        "description": "<string>",
        "buttonText": "<string>",
        "buttonLink": "<string>",
        "imageFileThumbnail": {
          "thumbnailWidth": 123,
          "thumbnailHeight": 123,
          "thumbnailUrl": "<string>",
          "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
        }
      }
    },
    "reviews": {
      "isSnapshot": true,
      "enabled": true,
      "items": [
        {
          "sourceId": "<string>",
          "name": "<string>",
          "clientName": "<string>",
          "clientRole": "<string>",
          "title": "<string>",
          "content": "<string>",
          "stars": 123,
          "clientProfilePictureFileThumbnail": {
            "thumbnailWidth": 123,
            "thumbnailHeight": 123,
            "thumbnailUrl": "<string>",
            "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
          },
          "imageFileThumbnail": {
            "thumbnailWidth": 123,
            "thumbnailHeight": 123,
            "thumbnailUrl": "<string>",
            "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
          },
          "position": 123
        }
      ]
    },
    "location": {
      "isSnapshot": true,
      "enabled": true,
      "item": {
        "sourceId": "<string>",
        "name": "<string>",
        "title": "<string>",
        "description": "<string>",
        "companyName": "<string>",
        "street": "<string>",
        "houseNumber": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "country": "<string>",
        "imageFileThumbnail": {
          "thumbnailWidth": 123,
          "thumbnailHeight": 123,
          "thumbnailUrl": "<string>",
          "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
        },
        "iconFileThumbnail": {
          "thumbnailWidth": 123,
          "thumbnailHeight": 123,
          "thumbnailUrl": "<string>",
          "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
        }
      }
    },
    "process": {
      "isSnapshot": true,
      "enabled": true,
      "item": {
        "sourceId": "<string>",
        "name": "<string>",
        "title": "<string>",
        "steps": [
          {
            "index": 123,
            "title": "<string>",
            "description": "<string>",
            "state": "DONE",
            "buttonText": "<string>"
          }
        ]
      }
    },
    "logos": {
      "isSnapshot": true,
      "enabled": true,
      "items": [
        {
          "sourceId": "<string>",
          "name": "<string>",
          "imageFileThumbnail": {
            "thumbnailWidth": 123,
            "thumbnailHeight": 123,
            "thumbnailUrl": "<string>",
            "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
          },
          "position": 123
        }
      ]
    }
  }
}

{
  "statusCode": 400,
  "code": "VALIDATION_ERROR",
  "message": "Validation failed",
  "details": {
    "errors": [
      "email must be a string"
    ]
  }
}

{
  "statusCode": 400,
  "code": "VALIDATION_ERROR",
  "message": "Validation failed",
  "details": {
    "errors": [
      "email must be a string"
    ]
  }
}

{
  "statusCode": 400,
  "code": "VALIDATION_ERROR",
  "message": "Validation failed",
  "details": {
    "errors": [
      "email must be a string"
    ]
  }
}

{
  "statusCode": 400,
  "code": "VALIDATION_ERROR",
  "message": "Validation failed",
  "details": {
    "errors": [
      "email must be a string"
    ]
  }
}

{
  "statusCode": 400,
  "code": "VALIDATION_ERROR",
  "message": "Validation failed",
  "details": {
    "errors": [
      "email must be a string"
    ]
  }
}

{
  "statusCode": 400,
  "code": "VALIDATION_ERROR",
  "message": "Validation failed",
  "details": {
    "errors": [
      "email must be a string"
    ]
  }
}

POST

v1.0

offers

{id}

mark-lost

Mark the offer as lost (declined). Returns the refreshed envelope.

curl --request POST \
  --url https://api.offerclub.io/v1.0/offers/{id}/mark-lost \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'

import requests

url = "https://api.offerclub.io/v1.0/offers/{id}/mark-lost"

payload = {}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.offerclub.io/v1.0/offers/{id}/mark-lost', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.offerclub.io/v1.0/offers/{id}/mark-lost",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.offerclub.io/v1.0/offers/{id}/mark-lost"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.offerclub.io/v1.0/offers/{id}/mark-lost")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.offerclub.io/v1.0/offers/{id}/mark-lost")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "publicId": "<string>",
  "offerNumber": "<string>",
  "status": "DRAFT",
  "title": "<string>",
  "subtitle": "<string>",
  "introduction": "<string>",
  "price": 123,
  "validUntil": "2023-11-07T05:31:56Z",
  "clientFirstName": "<string>",
  "clientLastName": "<string>",
  "clientEmail": "<string>",
  "clientPhone": "<string>",
  "clientCompanyName": "<string>",
  "sentToEmail": "<string>",
  "sentAt": "2023-11-07T05:31:56Z",
  "wonAt": "2023-11-07T05:31:56Z",
  "lostAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z",
  "acceptedByFirstName": "<string>",
  "acceptedByLastName": "<string>",
  "acceptedByEmail": "<string>",
  "acceptedByPhone": "<string>",
  "signatureFileId": "<string>",
  "declineReason": "NONE",
  "documentFileId": "<string>",
  "availableActions": {
    "canUpdate": true,
    "canDelete": true,
    "canSend": true,
    "canMarkWon": true,
    "canMarkLost": true,
    "canArchive": true,
    "canUnarchive": true,
    "canManagePaymentPlans": true,
    "canManageAssets": true
  },
  "publicUrl": "<string>",
  "signatureFileThumbnail": {
    "thumbnailWidth": 123,
    "thumbnailHeight": 123,
    "thumbnailUrl": "<string>",
    "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
  },
  "acceptedPaymentPlan": {
    "id": "<string>",
    "type": "UPFRONT",
    "installmentCount": 123,
    "computedSchedule": [
      {
        "position": 123,
        "source": "PERCENTAGE",
        "percentage": 123,
        "amount": 123,
        "dueDate": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "contactUser": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "role": "<string>",
    "avatarFileThumbnail": {
      "thumbnailWidth": 123,
      "thumbnailHeight": 123,
      "thumbnailUrl": "<string>",
      "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
    },
    "signatureFileThumbnail": {
      "thumbnailWidth": 123,
      "thumbnailHeight": 123,
      "thumbnailUrl": "<string>",
      "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
    }
  },
  "mainVideo": {
    "url": "<string>",
    "videoProvider": "YOUTUBE"
  },
  "callRecording": {
    "url": "<string>",
    "videoProvider": "YOUTUBE"
  },
  "paymentPlans": {
    "upfront": {
      "id": "<string>",
      "enabled": true,
      "computedSchedule": [
        {
          "position": 123,
          "source": "PERCENTAGE",
          "percentage": 123,
          "amount": 123,
          "dueDate": "2023-11-07T05:31:56Z"
        }
      ]
    },
    "split5050": {
      "id": "<string>",
      "enabled": true,
      "computedSchedule": [
        {
          "position": 123,
          "source": "PERCENTAGE",
          "percentage": 123,
          "amount": 123,
          "dueDate": "2023-11-07T05:31:56Z"
        }
      ]
    },
    "installments": {
      "items": [
        {
          "id": "<string>",
          "count": 3,
          "enabled": true,
          "computedSchedule": [
            {
              "position": 123,
              "source": "PERCENTAGE",
              "percentage": 123,
              "amount": 123,
              "dueDate": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ]
    },
    "custom": {
      "id": "<string>",
      "enabled": true,
      "computedSchedule": [
        {
          "position": 123,
          "source": "PERCENTAGE",
          "percentage": 123,
          "amount": 123,
          "dueDate": "2023-11-07T05:31:56Z"
        }
      ]
    }
  },
  "assets": {
    "faqs": {
      "isSnapshot": true,
      "enabled": true,
      "items": [
        {
          "sourceId": "<string>",
          "question": "<string>",
          "answer": "<string>",
          "position": 123
        }
      ]
    },
    "banner": {
      "isSnapshot": true,
      "enabled": true,
      "item": {
        "sourceId": "<string>",
        "name": "<string>",
        "title": "<string>",
        "description": "<string>",
        "buttonText": "<string>",
        "buttonLink": "<string>",
        "imageFileThumbnail": {
          "thumbnailWidth": 123,
          "thumbnailHeight": 123,
          "thumbnailUrl": "<string>",
          "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
        }
      }
    },
    "reviews": {
      "isSnapshot": true,
      "enabled": true,
      "items": [
        {
          "sourceId": "<string>",
          "name": "<string>",
          "clientName": "<string>",
          "clientRole": "<string>",
          "title": "<string>",
          "content": "<string>",
          "stars": 123,
          "clientProfilePictureFileThumbnail": {
            "thumbnailWidth": 123,
            "thumbnailHeight": 123,
            "thumbnailUrl": "<string>",
            "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
          },
          "imageFileThumbnail": {
            "thumbnailWidth": 123,
            "thumbnailHeight": 123,
            "thumbnailUrl": "<string>",
            "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
          },
          "position": 123
        }
      ]
    },
    "location": {
      "isSnapshot": true,
      "enabled": true,
      "item": {
        "sourceId": "<string>",
        "name": "<string>",
        "title": "<string>",
        "description": "<string>",
        "companyName": "<string>",
        "street": "<string>",
        "houseNumber": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "country": "<string>",
        "imageFileThumbnail": {
          "thumbnailWidth": 123,
          "thumbnailHeight": 123,
          "thumbnailUrl": "<string>",
          "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
        },
        "iconFileThumbnail": {
          "thumbnailWidth": 123,
          "thumbnailHeight": 123,
          "thumbnailUrl": "<string>",
          "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
        }
      }
    },
    "process": {
      "isSnapshot": true,
      "enabled": true,
      "item": {
        "sourceId": "<string>",
        "name": "<string>",
        "title": "<string>",
        "steps": [
          {
            "index": 123,
            "title": "<string>",
            "description": "<string>",
            "state": "DONE",
            "buttonText": "<string>"
          }
        ]
      }
    },
    "logos": {
      "isSnapshot": true,
      "enabled": true,
      "items": [
        {
          "sourceId": "<string>",
          "name": "<string>",
          "imageFileThumbnail": {
            "thumbnailWidth": 123,
            "thumbnailHeight": 123,
            "thumbnailUrl": "<string>",
            "thumbnailUrlExpiresAt": "2023-11-07T05:31:56Z"
          },
          "position": 123
        }
      ]
    }
  }
}

{
  "statusCode": 400,
  "code": "VALIDATION_ERROR",
  "message": "Validation failed",
  "details": {
    "errors": [
      "email must be a string"
    ]
  }
}

{
  "statusCode": 400,
  "code": "VALIDATION_ERROR",
  "message": "Validation failed",
  "details": {
    "errors": [
      "email must be a string"
    ]
  }
}

{
  "statusCode": 400,
  "code": "VALIDATION_ERROR",
  "message": "Validation failed",
  "details": {
    "errors": [
      "email must be a string"
    ]
  }
}

{
  "statusCode": 400,
  "code": "VALIDATION_ERROR",
  "message": "Validation failed",
  "details": {
    "errors": [
      "email must be a string"
    ]
  }
}

{
  "statusCode": 400,
  "code": "VALIDATION_ERROR",
  "message": "Validation failed",
  "details": {
    "errors": [
      "email must be a string"
    ]
  }
}

{
  "statusCode": 400,
  "code": "VALIDATION_ERROR",
  "message": "Validation failed",
  "details": {
    "errors": [
      "email must be a string"
    ]
  }
}

Authorizations

x-api-key

string

header

required

API key for authentication (can be generated in the settings)

Path Parameters

string

required

Body

application/json

reason

enum<string> | null

Reason for marking the offer as lost. Persisted as null when omitted.

Available options:

NONE,

TOO_EXPENSIVE,

OTHER_PRIORITIES,

TIMELINE,

MISSING_EXPERTISE,

PERSONAL_FIT

Response

Offer marked as lost

string

required

The ID of the element

createdAt

string<date-time>

required

The created at date of the element

updatedAt

string<date-time>

required

The updated at date of the element

publicId

string

required

Short URL-safe identifier used in the public share link

offerNumber

string | null

required

User-set business reference number

status

enum<string>

required

Current offer status

Available options:

DRAFT,

SENT,

WON,

LOST

title

string | null

required

Offer title shown to the client

subtitle

string | null

required

Subtitle shown beneath the title

introduction

string | null

required

Introductory text shown at the top of the offer page

price

number | null

required

Total offer price in the smallest currency unit (cents)

validUntil

string<date-time> | null

required

Date until which the offer is valid

clientFirstName

string | null

required

Client first name

clientLastName

string | null

required

Client last name

clientEmail

string | null

required

Client email address

clientPhone

string | null

required

Client phone number

clientCompanyName

string | null

required

Client company name

sentToEmail

string | null

required

Email address the offer was actually sent to (snapshot at send-time)

sentAt

string<date-time> | null

required

Timestamp when the offer was sent

wonAt

string<date-time> | null

required

Timestamp when the offer was marked as won

lostAt

string<date-time> | null

required

Timestamp when the offer was marked as lost

archivedAt

string<date-time> | null

required

Timestamp when the offer was archived

acceptedByFirstName

string | null

required

First name of the person who accepted the offer via the public surface

acceptedByLastName

string | null

required

Last name of the person who accepted the offer via the public surface

acceptedByEmail

string | null

required

Email of the person who accepted the offer

acceptedByPhone

string | null

required

Phone number of the person who accepted the offer

signatureFileId

string | null

required

File ID of the captured signature image

declineReason

enum<string> | null

required

Reason given by the recipient when declining the offer (NONE if no reason provided)

Available options:

NONE,

TOO_EXPENSIVE,

OTHER_PRIORITIES,

TIMELINE,

MISSING_EXPERTISE,

PERSONAL_FIT

documentFileId

string | null

required

File ID of the attached PDF document

availableActions

object

required

Server-computed map of dashboard actions the caller may currently perform on this offer

Show child attributes

publicUrl

string | null

required

Fully constructed public share URL (includes the auth token) - null if the offer is not sent yet

signatureFileThumbnail

object | null

required

Thumbnail of the captured signature — null when no signature is attached (offer not yet accepted via the public surface)

Show child attributes

acceptedPaymentPlan

object | null

required

The plan the recipient chose at accept-time — null until the offer is accepted (WON). All other plans are fetched via GET /offers/:offerId/payment-plans.

Show child attributes

contactUser

object | null

required

Organization member shown as contact person on the offer — null when no contact is assigned

Show child attributes

mainVideo

object | null

required

Main video of the offer — null when none is set

Show child attributes

callRecording

object | null

required

Call recording of the offer — null when none is set

Show child attributes

paymentPlans

object

required

Grouped payment-plans snapshot for the offer. Same shape as GET /offers/:offerId/payment-plans.

Show child attributes

assets

object

required

Grouped assets snapshot for the offer. Same shape as GET /offers/:offerId/assets.

Show child attributes

Healthcheck

Files

Assets

Offers

Mark the offer as lost (declined). Returns the refreshed envelope.

Authorizations

Path Parameters

Body

Response