Create a Firm
POST {{base_url}}/firm
Use this endpoint to create a new firm in the Firms hub.
Specify the data for the new firm in the request body. Minimum required data include required fields and defaults from the firm metadata.
The metadata will have the most up to date details for your instance of Vantagepoint when calling the API using your authenticated environment.
Request
A successful call status of 201 Created returns the JSON representation for the newly created firm.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
requiredFieldValidation | string | Optional. |
The flag that indicates whether or not the validation for required screen designer fields is needed.
Use "N" if you want to bypass the validation. Otherwise, the default is "Y," which enforces the validation.
NOTE: This does not apply to required system fields. |
| startWorkflow | string | | Optional.
The flag that indicates whether or not the trigger for a workflow is initiated.
Use "N" if you want to bypass the trigger. Otherwise, the default is "Y," which initiates the workflow. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
RESPONSES
status: Created
""