Skip to content

[CXE-3] Add additional parameters to application payload in README #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hisanibrahim merged 1 commit into from
Apr 23, 2026
Merged

[CXE-3] Add additional parameters to application payload in README #85

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,10 @@ required. The candidate will be emailed after they apply to the job, unless the
| `silent` | Disables confirmation email sent to candidates upon application. Accepts values of `true`, `false`, `"true"` or `"false"`.
| `source` | Adds a source tag to candidate (e.g. 'LinkedIn')
| `ip` | IP application was submitted from, used for detecting country for compliance reasons (e.g. `"184.23.195.146"`)
| `timezone` | IANA timezone identifier for the applicant (e.g. `"America/New_York"`). Invalid timezone strings are silently ignored.
| `userAgent` | User-Agent string for the applicant's client. If omitted, captured from the `User-Agent` request header. Useful for backend/proxy integrations forwarding a browser's value. Truncated to 512 characters.
| `acceptLanguage` | Accept-Language string for the applicant's client. If omitted, captured from the `Accept-Language` request header. Truncated to 256 characters.
| `referer` | Referring URL for the application. If omitted, captured from the `Referer` request header. Truncated to 2048 characters.
| `consent.marketing` | Indicate whether candidate is open to being contacted about future opportunities (e.g. `"consent":{"marketing":true}` for `JSON`, or `consent[marketing]=true` for `multipart/form-data`)<br><br>A `compliancePolicyId` can be added to indicate the policy that applies to this posting (e.g. `consent":{"marketing": {"provided": true, "compliancePolicyId": "<guid_of_policy>"}}` for `JSON`, or `consent[marketing][provided]=true` and `consent[marketing][compliancePolicyId]="<guid_of_policy>"` for `multipart/form-data`)<br>Note: to be released in waved rollouts starting mid-September, 2024
| `consent.store` | Indicate whether the candidate has provided consent for the purpose of storing and processing their data (e.g. `"consent":{"store":true}` for `JSON`, or `consent[store]=true` for `multipart/form-data`)<br>Note: to be released in waved rollouts starting mid-September, 2024<br><br>A `compliancePolicyId` can be added to indicate the policy that applies to this posting (e.g. `consent":{"store": {"provided": true, "compliancePolicyId": "<guid_of_policy>"}}` for `JSON`, or `consent[store][provided]=true` and `consent[store][compliancePolicyId]="<guid_of_policy>"` for `multipart/form-data`)<br>Note: to be released in waved rollouts starting mid-September, 2024
| `opportunityLocation` | The posting location associated with the opportunity. If no posting is provided, opportunityLocation is not set. If not specified and a multi-location posting is provided, opportunityLocation defaults to “unspecified”. Defaults to the posting location for single-location postings.
Expand Down
Loading