GuidesRecipesAPI Reference
Log In
API Reference

Create a company milestone

This endpoint will create a milestone for the given company.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Company ID.

Body Params

Available properties for creating a milestone

string
required
length between 1 and 255

Milestone name.

string
required
length between 1 and 65536

Milestone description.

remote_name
array of strings
required
length ≥ 1

Milestone remote name(s).

remote_name*
messages
object

Properties available for a milestone's messages.

boolean

Whether document uploads are allowed for milestone (defaults to true).

boolean

Whether the milestone is viewable in the LOS (defaults to true).

boolean

Whether the borrower is notified for loan changes in milestone (defaults to false).

Headers
string

Specify API version, for example '1.0'. By default, the version configured in the company settings is used.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json