Create an applicant
/v1/applicantsCreates an applicant and returns it. Send an Idempotency-Key header to make the request safe to retry. Available to keys belonging to office staff. Requires a key with write scope.
Headers
A unique value (a UUID works well) that makes this request safe to retry for 24 hours. A retry with the same key and body returns the first result; the same key with a different body is refused with idempotency_conflict.
Request body
application/jsonGiven name.
Middle name.
Family name.
Email address.
Phone number.
Hiring stage, as named in your pipeline.
When the application was received.
Where the applicant found you.
Who referred the applicant.
City.
State, as a two-letter code.
ZIP code.
Earliest date the applicant can start.
Hourly pay the applicant is asking for, in dollars.
Hours per week the applicant can work.
Years of caregiving experience.
Primary language.
Whether the applicant has a driver's license.
Whether the applicant has reliable transportation.
Whether the applicant holds a current CPR certification.
Scheduled or completed interview time.
Status of any job offer.
The office the applicant applied to.
Recruiter notes.
Response
201The new applicant.
String representing the object's type. Always applicant.
Unique identifier of the applicant.
Given name.
Middle name.
Family name.
Email address.
Phone number.
Hiring stage, as named in your pipeline.
When the applicant last moved stage.
When the application was received.
Where the applicant found you.
Who referred the applicant.
City.
State, as a two-letter code.
ZIP code.
Earliest date the applicant can start.
Hourly pay the applicant is asking for, in dollars.
Hours per week the applicant can work.
Years of caregiving experience.
Primary language.
Whether the applicant has a driver's license.
Whether the applicant has reliable transportation.
Whether the applicant holds a current CPR certification.
Scheduled or completed interview time.
Status of any job offer.
The office the applicant applied to.
Recruiter notes.
The caregiver record created when the applicant was hired.
When the applicant was created.
When the applicant was last changed.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Idempotent-ReplayedstringPresent and true when this response is the stored result of an earlier request with the same Idempotency-Key.Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 409 | n/a | The Idempotency-Key was already used with a different request, or that request is still running (idempotency_conflict). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.