Settings

Update board settings

Changed on

Updates typed board settings by setting the values supplied. Omitted values remain unchanged; settings outside this allowlist use their dedicated product endpoint.

patch/settings

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/settings
  • Auth: HTTP bearer

Request body

namestring

Display name of the board.

slugstring

URL slug of the board. Lowercase alphanumeric and hyphens; reserved values (e.g. admin, api) are rejected.

primaryDomainIdstring

Identifier of the custom domain to use as the primary public URL.

logoMediaIdstring

Cavuno media ID returned by POST /v1/media/upload with purpose=board_logo.

heroMediaIdstring

Cavuno media ID returned by POST /v1/media/upload with purpose=board_hero.

passwordProtectionEnabledboolean

Whether the board sits behind a password gate. Use POST /v1/settings/password-protection to set the actual password before enabling.

jobAlertsEnabledboolean

Whether candidates can subscribe to email alerts for new jobs.

jobRecommendationsEnabledboolean

Whether signed-in candidates can see personalized job recommendations. Absent board config defaults to true.

recommendedTalentEnabledboolean

Whether employers can see recommended talent matches for their jobs. Absent board config defaults to false.

candidatesEnabledboolean

Whether candidate profiles are enabled on the board.

employersEnabledboolean

Whether employer self-serve flows are enabled.

blogEnabledboolean

Whether the public blog is exposed.

impressumEnabledboolean

Whether the legal Impressum page is exposed (required in some jurisdictions).

requireApprovalFreeJobsboolean

Whether jobs posted by employers from the free tier require admin approval before they appear on the public board.

postingRequiresMembershipboolean

When true, only companies with an active plan assignment can post jobs. Absent means anyone can post.

requireApprovalAggregatedJobsboolean

Whether aggregated jobs (e.g. those sourced or imported from upstream sources) require admin approval before they appear on the public board.

registrationWallEnabledboolean

Whether visitors must sign in to view jobs.

nativeApplicationsEnabledboolean

Whether the board's built-in ATS receives applications. When false (external-applications-only board), posting surfaces require an external applicationUrl and POST /boards/:identifier/jobs/:jobSlug/apply rejects with applications_native_disabled. Turning this off UNPUBLISHES every published native-apply job (those with no external applicationUrl) back to draft via an asynchronous batched drain. Expect published job counts to shrink over the following seconds. Nothing is deleted, and re-enabling does NOT republish the drafted jobs. Absent means true.

countryGatingMode'sponsored_only' | 'all_jobs'

Apply country gate mode. The default is sponsored_only; all_jobs also gates ordinary external and native starter applies.

applicantMessagingEnabledboolean

Whether applicant↔employer messaging is enabled. When false, the me/conversations route family rejects with messaging_disabled and new-message emails are suppressed. Absent means true.

talentDirectoryEnabledboolean

Legacy shorthand for the talent directory. true maps to talentDirectoryVisibility: "public"; false maps to "off". Prefer the tri-state field. Providing both with conflicting values returns settings_conflicting_fields.

talentDirectoryVisibility'off' | 'public' | 'employers_only'

Talent directory access mode: off (hidden), public (anyone), or employers_only (approved employers). Canonical field; supersedes talentDirectoryEnabled.

defaultCandidateProfileVisibility'hidden' | 'logged_in_only' | 'public'

Visibility a candidate profile is created with at signup: hidden (not listed), logged_in_only (signed-in visitors), or public. Defaults to hidden, which matches what an unset value already means — the talent directory lists only public and logged_in_only profiles. Applies at signup ONLY: it never rewrites an existing profile, and a candidate can change their own afterwards. Composes with talentDirectoryVisibility, which controls who may browse the directory at all.

requireCookieConsentboolean

Whether the public board shows a cookie consent banner before non-essential tracking runs.

cookieBannerTitlestring

Title shown on the cookie consent banner. 1–200 characters.

cookieBannerDescriptionstring

Body copy shown on the cookie consent banner. 1–500 characters.

cookieBannerRejectLabelstring

Reject-button label on the cookie consent banner. 1–80 characters.

cookieBannerAcceptLabelstring

Accept-button label on the cookie consent banner. 1–80 characters.

cookieBannerManageLabelstring

Preferences/manage-button label on the cookie consent banner. 1–80 characters.

showCavunoBrandingboolean

Whether the Cavuno-branded footer is displayed on the public board. Plan-gated; lower-tier plans cannot disable this.

defaultJobDurationDaysinteger

Default expiry, in days, applied to newly published jobs when no expiresAt is supplied.

ga4MeasurementIdstring nullable

Google Analytics 4 measurement ID (for example G-XXXXXXXXXX) loaded on the public board. Letters, digits, - and _, up to 120 characters. Pass null or an empty string to clear.

gtmContainerIdstring nullable

Google Tag Manager container ID (for example GTM-XXXXXXX) loaded on the public board. Letters, digits, - and _, up to 120 characters. Pass null or an empty string to clear.

metaPixelIdstring nullable

Meta Pixel ID loaded on the public board. Letters, digits, - and _, up to 120 characters. Pass null or an empty string to clear.

linkedinPartnerIdstring nullable

LinkedIn Insight Tag partner ID loaded on the public board. Letters, digits, - and _, up to 120 characters. Pass null or an empty string to clear.

linkedinConversionSignUpIdstring nullable

LinkedIn conversion ID fired when a visitor signs up. Letters, digits, - and _, up to 120 characters. Pass null or an empty string to clear.

linkedinConversionLoginIdstring nullable

LinkedIn conversion ID fired when a visitor signs in. Letters, digits, - and _, up to 120 characters. Pass null or an empty string to clear.

linkedinConversionApplyClickIdstring nullable

LinkedIn conversion ID fired when a visitor clicks Apply. Letters, digits, - and _, up to 120 characters. Pass null or an empty string to clear.

linkedinConversionApplySubmitIdstring nullable

LinkedIn conversion ID fired when a visitor submits an application. Letters, digits, - and _, up to 120 characters. Pass null or an empty string to clear.

linkedinConversionJobAlertSubscribeIdstring nullable

LinkedIn conversion ID fired when a visitor subscribes to job alerts. Letters, digits, - and _, up to 120 characters. Pass null or an empty string to clear.

talentNavLabelstring

Label shown for the talent directory in the public navigation. 1–50 characters.

Response

Successful response.

idstring required
object'settings' required
accountIdstring required
namestring required
slugstring required
primaryDomainIdstring nullable required
logoUrlstring nullable required
heroUrlstring nullable required
createdAtstring required
updatedAtstring required

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status