Skip to navigation
EntryPartner Entry

Update a partner entry

View as Markdown

Update partner entry details. Filters marked as required may be left empty and image may be null to remove the logo: completing the profile is the partner’s job. A filter option id that does not exist in this directory answers 400 under userAssignedFilterOptions, and nothing is saved.

Authentication

AuthorizationToken

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

Path parameters

directoryIdstringRequiredformat: "uuid"
id of the directory
entryIdstringRequiredformat: "uuid"
id of the Partner entry

Request

This endpoint expects an object.
idstringOptionalformat: "uuid"
titlestringOptional1-256 characters
headlinestring or nullOptional1-250 characters
typestringOptional1-100 characters
slugstringOptionalformat: "^[-a-zA-Z0-9_]+$"1-60 characters
customSlugstring or nullOptionalformat: "^[-a-zA-Z0-9_]+$"1-60 characters
statusenumOptional
  • hidden - hidden
  • inactive - inactive
  • public - public
  • searchable - searchable
Allowed values:
iconstring or nullOptionalformat: "binary"
imagestring or nullOptionalformat: "binary"
iconDarkstring or nullOptionalformat: "binary"
imageDarkstring or nullOptionalformat: "binary"
websitestring or nullOptionalformat: "uri">=1 character
lastModifiedobject or nullOptional

Serializer for last_modified info including timestamp and user details.

featuredbooleanOptional
ownermap from strings to any or nullOptional
userAssignedFilterOptionslist of stringsOptional
descriptionstring or nullOptional>=1 character
integrationDescriptionstring or nullOptional
locationstring or nullOptional1-255 characters
callToActionUrlstring or nullOptional1-200 characters

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

callToActionLabelstring or nullOptional1-25 characters
internalPointOfContactCtaUrlstring or nullOptional
internalPointOfContactCtaLabelstring or nullOptional<=25 characters
internalChannelContactCtaUrlstring or nullOptional
internalChannelContactCtaLabelstring or nullOptional<=25 characters
externalUrlstring or nullOptionalformat: "uri">=1 character
availabilityboolean or nullOptional
externalIdstring or nullOptional<=100 characters
resourceslist of objectsOptional
awardslist of objectsOptional
verificationslist of objects or nullOptional
medialist of objects or nullOptional
calloutslist of objectsOptional
keywordslist of objectsOptional
supportEmailstring or nullOptional1-250 characters
developerNamestring or nullOptional1-250 characters
displayOnInternalDirectorybooleanOptional
contactRequestsHiddenbooleanOptional

When on, visitors cannot send this entry a contact request; the directory-wide contact requests setting still applies

internalDescriptionstring or nullOptional
iconUrlstring or nullOptionalformat: "uri">=1 character
imageUrlstring or nullOptionalformat: "uri">=1 character
metaTitlestring or nullOptional<=70 characters
metaDescriptionstring or nullOptional<=160 characters
tierstringOptionalformat: "uuid"
embedCodestring or nullOptional<=20000 characters

The embed code as the provider gives it. Only the first iframe with an https address is kept; null or blank removes the embed

embedTitlestring or nullOptional<=60 characters
embedHeightinteger or nullOptional200-1200
profileFieldsmap from strings to anyOptional

Values of the directory’s profile fields by field key. Keys sent are set, null (or blank text, or [] for a multiple choice) clears one, keys not sent are kept. An image or file field takes the URL that POST /api/core/private/v1alpha/files/ returned, or {url, name}

Response

Successful operation
hrefstringRead-only
idstringformat: "uuid"
titlestring<=256 characters
headlinestring or null<=250 characters
typestring<=100 characters
slugstringformat: "^[-a-zA-Z0-9_]+$"<=60 characters
customSlugstring or nullformat: "^[-a-zA-Z0-9_]+$"<=60 characters
statusenum
  • hidden - hidden
  • inactive - inactive
  • public - public
  • searchable - searchable
Allowed values:
iconstring or null
imagestring or null
iconDarkstring or null
imageDarkstring or null
websitestring or nullformat: "uri"
featuredboolean
ownermap from strings to any or null
userAssignedFilterOptionsstringRead-only
systemAssignedFilterOptionsstringRead-only
mappedAssignedFilterOptionsstringRead-only
descriptionstring or null
locationstring or null<=255 characters
callToActionUrlstring or null
callToActionLabelstring or null<=25 characters
externalUrlstring or nullformat: "uri"
externalIdstring or null
resourceslist of objects
awardslist of objects
supportEmailstring or null<=250 characters
developerNamestring or null<=250 characters
contactRequestsHiddenboolean

When on, visitors cannot send this entry a contact request; the directory-wide contact requests setting still applies

contactsRestrictedboolean
Whether only the listed contacts work this profile and get its leads
certificationsstringRead-only
badgeslist of maps from strings to anyRead-only
Assigned badges in badge order. Each badge links to its assignment on the entry, so the entry id comes from the data, not the serializer context.
trackingobject
approvalFlowstringRead-only
readyForReviewboolean
isNewboolean
createddatetime
tierobject or null
lastModifiedobject or nullOptional

Serializer for last_modified info including timestamp and user details.

integrationDescriptionstring or nullOptional
internalPointOfContactCtaUrlstring or nullOptional
internalPointOfContactCtaLabelstring or nullOptional<=25 characters
internalChannelContactCtaUrlstring or nullOptional
internalChannelContactCtaLabelstring or nullOptional<=25 characters
availabilityboolean or nullOptional
verificationslist of objects or nullOptional
medialist of objects or nullOptional
calloutslist of objectsOptional
keywordslist of objectsOptional
displayOnInternalDirectoryboolean or nullOptional
internalDescriptionstring or nullOptional
iconUrlstring or nullOptional
imageUrlstring or nullOptional
metaTitlestring or nullOptional<=70 characters
metaDescriptionstring or nullOptional<=160 characters
embedTitlestring or nullOptional
embedSrcstring or nullOptionalformat: "uri"
profileFieldsmap from strings to anyOptional
embedHeightinteger or nullOptional

Errors

404
Not Found Error