Update the settings for a directory | PartnerPage Developers

curl -X PATCH https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/directoryId/settings/ \
     -H "Authorization: Token  <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "href": "/api/directory/private/v1alpha/directories/e6704845-131a-43b7-a72f-56fbb0c6e72d/settings/",
  "genericDirectoryId": "e6704845-131a-43b7-a72f-56fbb0c6e72d",
  "customUrl": null,
  "globalCallToActionUrl": "string",
  "globalCallToActionLabel": "string",
  "contactButtonLabel": "string",
  "featuredEntriesEnabled": false,
  "entryTypes": [
    "app",
    "partner"
  ],
  "entryTypeSettings": {
    "app": {
      "urlSegment": "app",
      "onCardClick": "details",
      "showCardLinksAsInternal": false
    },
    "partner": {
      "urlSegment": "partner"
    }
  },
  "pageSizeSelectionOnDirectory": false,
  "filterMappingsEnabled": false,
  "badgesEnabled": false,
  "calloutsEnabled": false,
  "customFormsEnabled": true,
  "certificationsEnabled": false,
  "verificationsEnabled": false,
  "callToActionEnabled": true,
  "awardsEnabled": true,
  "availabilityToggleEnabled": true,
  "landingPageEnabled": true,
  "customLandingPagesEnabled": true,
  "partnerPortalEnabled": true,
  "customSlugEnabled": true,
  "darkLogosEnabled": true,
  "partnerCompareEnabled": true,
  "embeddedEditorEnabled": true,
  "keywordsEnabled": true,
  "questionnaireEnabled": true,
  "mediaEnabled": true,
  "caseStudiesEnabled": false,
  "clientsEnabled": true,
  "testimonialsEnabled": true,
  "specialOffersEnabled": true,
  "contactRequestsEnabled": false,
  "dealRegistrationsEnabled": true,
  "partnerSourcedLeadsRequireApproval": true,
  "crmConnectionsEnabled": true,
  "tiersEnabled": true,
  "matchmakingRequestsEnabled": true,
  "matchmakingRequestsPublic": true,
  "partnerApplicationsEnabled": true,
  "getListedEnabled": true,
  "assignMatchmakingRequestEnabled": true,
  "useCasesEnabled": true,
  "accreditationsEnabled": true,
  "externalUrlEnabled": false,
  "externalIdEnabled": true,
  "externalIdUnique": false,
  "partnerWebhooksEnabled": true,
  "partnerApplicationDeclinedEmailEnabled": true,
  "partnerApplicationAcceptanceMessage": "string",
  "showBottomBar": false,
  "legacyPartnerViewEnabled": true,
  "profileSectionOrderingEnabled": true,
  "hostedPagesDisabled": true,
  "profilePreviewUrlTemplate": "string",
  "holdRepeatedRequestsEnabled": true,
  "serviceMarketplaceEnabled": true,
  "recommendedSortEnabled": false,
  "internalDirectoryEnabled": true,
  "defaultSorting": "random",
  "entryApprovalFlowEnabled": false,
  "supportEnabled": false,
  "locationEnabled": true,
  "locationsEnabled": true,
  "contactRequestProjectStatusesEnabled": false,
  "contactDetailsAfterAcceptEnabled": true,
  "partnersInvitationsEnabled": true,
  "lastUpdatedEnabled": false,
  "entryDisclaimerTextEnabled": true,
  "gdprEnabled": true,
  "termsOfServiceUrl": null,
  "privacyPolicyUrl": null,
  "integrationDescriptionEnabled": true,
  "partnerEmbedEnabled": true,
  "partnerDescriptionMaxLength": 1,
  "reviewsEnabled": true,
  "autoApproveReviewsEnabled": true,
  "showFullReviewInformationEnabled": true,
  "showDescriptionOnCard": true,
  "i18nEnabled": true,
  "i18nMode": "prefix",
  "i18nLanguages": null,
  "i18nDynamicContentTranslationEnabled": true,
  "partnerFinderEnabled": true,
  "badgesShowWideEnabled": true,
  "crmObjectsEnabled": true,
  "schedulerEnabled": true,
  "schedulerPostCallFeedbackEnabled": true,
  "enrichProfileDirOwnerEnabled": true,
  "enrichProfileEntryOwnerEnabled": true,
  "entryWebsiteLinkEnabled": true,
  "contactRequestsCustomFieldsForm": "string",
  "requireBusinessEmailForLeadForms": true,
  "selfServeSettingsEnabled": true,
  "indexDirectory": true,
  "type": "string",
  "plan": "string",
  "urlCustomizationEnabled": true,
  "webhooksEnabled": true,
  "webhooksSecret": "string",
  "customUrlSetupMethod": "string",
  "customDomainRouterId": "string",
  "autoApproveReviews": true,
  "organizationInvitesToOwnPartnersEnabled": false,
  "showFullReviewInformation": false
}

Update the settings for a specific directory.

Authentication

AuthorizationToken

Your API key, sent as Authorization: Token <your API key>

Path parameters

directoryIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.

termsOfServiceUrlstring or nullOptional

privacyPolicyUrlstring or nullOptional

defaultSortingenumOptional

title - Title A-Z
-title - Title Z-A
random - Random
recommended - Recommended (asc)
tier - Tier (asc)
tier_review - Tier (asc) & Review Count (desc)
tier_review_average - Top Rated

entryDisclaimerTextstring or nullOptional

customUrlstring or nullOptional

customUrlSetupMethodstring or nullOptional>=1 character

landingPageEnabledbooleanOptional

externalIdUniquebooleanOptional

partnerWebhooksEnabledbooleanOptional

partnerApplicationDeclinedEmailEnabledbooleanOptional

partnerApplicationAcceptanceMessagestring or nullOptional

featuredEntriesEnabledbooleanOptional

tiersEnabledbooleanOptional

badgesEnabledbooleanOptional

badgesShowWideEnabledbooleanOptional

certificationsEnabledbooleanOptional

verificationsEnabledbooleanOptional

calloutsEnabledbooleanOptional

availabilityToggleEnabledbooleanOptional

specialOffersEnabledbooleanOptional

pageSizeSelectionOnDirectorybooleanOptional

showDescriptionOnCardbooleanOptional

lastUpdatedEnabledbooleanOptional

entryWebsiteLinkEnabledbooleanOptional

mediaEnabledbooleanOptional

caseStudiesEnabledbooleanOptional

clientsEnabledbooleanOptional

useCasesEnabledbooleanOptional

testimonialsEnabledbooleanOptional

awardsEnabledbooleanOptional

accreditationsEnabledbooleanOptional

keywordsEnabledbooleanOptional

locationsEnabledbooleanOptional

integrationDescriptionEnabledbooleanOptional

partnerDescriptionMaxLengthinteger or nullOptional1-2500

questionnaireEnabledbooleanOptional

customSlugEnabledbooleanOptional

enrichProfileEntryOwnerEnabledbooleanOptional

contactRequestsEnabledbooleanOptional

partnerSourcedLeadsRequireApprovalbooleanOptional

contactRequestProjectStatusesEnabledbooleanOptional

contactDetailsAfterAcceptEnabledbooleanOptional

requireBusinessEmailForLeadFormsbooleanOptional

contactButtonLabelstring or nullOptional<=25 characters

callToActionEnabledbooleanOptional

globalCallToActionLabelstring or nullOptional<=25 characters

globalCallToActionUrlstring or nullOptional<=255 characters

An http(s) address or a mailto: link.

matchmakingRequestsEnabledbooleanOptional

assignMatchmakingRequestEnabledbooleanOptional

reviewsEnabledbooleanOptional

autoApproveReviewsEnabledbooleanOptional

partnerApplicationsEnabledbooleanOptional

getListedEnabledbooleanOptional

partnersInvitationsEnabledbooleanOptional

indexDirectorybooleanOptional

enrichProfileDirOwnerEnabledbooleanOptional

Response

Successful operation

hrefstringRead-only

genericDirectoryIdstringformat: "uuid"

customUrlstring or nullformat: "uri"

globalCallToActionUrlstring or null<=255 characters

globalCallToActionLabelstring or null<=25 characters

contactButtonLabelstring or null<=25 characters

featuredEntriesEnabledboolean

entryTypeslist of enums

Allowed values:

entryTypeSettingsmap from strings to objects

pageSizeSelectionOnDirectoryboolean

filterMappingsEnabledboolean

badgesEnabledboolean

calloutsEnabledboolean

customFormsEnabledboolean

certificationsEnabledboolean

verificationsEnabledboolean

callToActionEnabledboolean

awardsEnabledboolean

availabilityToggleEnabledboolean

landingPageEnabledboolean

customLandingPagesEnabledboolean

partnerPortalEnabledboolean

customSlugEnabledboolean

darkLogosEnabledboolean

partnerCompareEnabledboolean

embeddedEditorEnabledboolean

keywordsEnabledboolean

questionnaireEnabledboolean

mediaEnabledboolean

caseStudiesEnabledboolean

clientsEnabledboolean

testimonialsEnabledboolean

specialOffersEnabledboolean

contactRequestsEnabledboolean

dealRegistrationsEnabledboolean

partnerSourcedLeadsRequireApprovalboolean

crmConnectionsEnabledboolean

tiersEnabledboolean

matchmakingRequestsEnabledboolean

matchmakingRequestsPublicboolean

partnerApplicationsEnabledboolean

getListedEnabledboolean

assignMatchmakingRequestEnabledboolean

useCasesEnabledboolean

accreditationsEnabledboolean

externalUrlEnabledboolean

externalIdEnabledboolean

externalIdUniqueboolean

partnerWebhooksEnabledboolean

partnerApplicationDeclinedEmailEnabledboolean

partnerApplicationAcceptanceMessagestring or null

showBottomBarboolean

legacyPartnerViewEnabledboolean

profileSectionOrderingEnabledboolean

hostedPagesDisabledboolean

profilePreviewUrlTemplatestring

holdRepeatedRequestsEnabledboolean

serviceMarketplaceEnabledboolean

recommendedSortEnabledboolean

internalDirectoryEnabledboolean

defaultSortingstring

entryApprovalFlowEnabledboolean

supportEnabledboolean

locationEnabledboolean

locationsEnabledboolean

contactRequestProjectStatusesEnabledboolean

contactDetailsAfterAcceptEnabledboolean

partnersInvitationsEnabledboolean

lastUpdatedEnabledboolean

entryDisclaimerTextEnabledboolean

gdprEnabledboolean

termsOfServiceUrlstring or null

privacyPolicyUrlstring or null

integrationDescriptionEnabledboolean

partnerEmbedEnabledboolean

partnerDescriptionMaxLengthinteger or null>=1

reviewsEnabledboolean

autoApproveReviewsEnabledboolean

showFullReviewInformationEnabledboolean

showDescriptionOnCardboolean

i18nEnabledboolean

i18nModeenum or null

prefix - Prefix
query_param - Query param

Allowed values:

i18nLanguagesany or null

i18nDynamicContentTranslationEnabledboolean or null

partnerFinderEnabledboolean

badgesShowWideEnabledboolean

crmObjectsEnabledboolean

schedulerEnabledboolean

schedulerPostCallFeedbackEnabledboolean

enrichProfileDirOwnerEnabledboolean

enrichProfileEntryOwnerEnabledboolean

entryWebsiteLinkEnabledboolean

contactRequestsCustomFieldsFormstring or nullformat: "uuid"

requireBusinessEmailForLeadFormsboolean

selfServeSettingsEnabledboolean

indexDirectoryboolean

typestring

planstring

urlCustomizationEnabledboolean

webhooksEnabledboolean

webhooksSecretstringRead-only

customUrlSetupMethodstring or null

customDomainRouterIdstring or nullformat: "uuid"

entryDisclaimerTextstring or nullOptional

profileFieldsEnabledbooleanOptionalDefaults to false

profileFieldDefinitionslist of objectsOptional

friendlySubdomainstring or nullOptional

friendlyUrlstring or nullOptionalformat: "uri"

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error