For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get SupportGet a demo
  • Get Started
    • Welcome
    • Quickstart
  • Webhooks
    • Introduction
    • Creating a Webhook
    • Available Webhooks
  • Public API Reference (Beta)
    • Applicants/Candidates
    • Contacts/Managers
    • Clients/Departments
        • POSTCreate a submittal (submit an applicant to a requirement)
        • DELDelete a submittal
        • GETGet a submittal by GUID
        • GETList submittals. Either requirementGuid or applicantGuid must be supplied.
        • PUTUpdate a submittal
  • Internal API Reference
    • Applicants/Candidates
    • Clients/Departments
    • Contacts/Managers
LogoLogo
Get SupportGet a demo
Public API Reference (Beta)SubmittalsCore

Create a submittal (submit an applicant to a requirement)

POST
https://app.brightmove.com/ATS/api/v1/submittals
POST
/ATS/api/v1/submittals
$curl -X POST https://app.brightmove.com/ATS/api/v1/submittals \
>     -H "X-Brightmove-Company-ApiKey: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "requirementGuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
>  "applicantGuid": "d4e5f6a7-b8c9-0123-defa-234567890123"
>}'
201Created
1{}
Was this page helpful?
Previous

Delete a submittal

Next
Built with

Authentication

X-Brightmove-Company-ApiKeystring
BrightMove Company Api Key
X-Brightmove-User-ApiKeystring
BrightMove User Api Key

Request

This endpoint expects an object.
requirementGuidstringRequired
GUID of the requirement to submit the applicant to.
applicantGuidstringRequired
GUID of the applicant being submitted.
notestringOptional
Optional note to record with the submittal.

Response

Submittal created