Create a partner entry

POST

https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/:directoryId/entries/partners/

POST

/api/directory/private/v1alpha/directories/:directoryId/entries/partners/

curl -X POST https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/directoryId/entries/partners/ \
     -H "Authorization: Token  <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "title": "string",
  "headline": "string",
  "description": "string",
  "website": "string"
}'

{
  "href": "/api/directory/private/v1alpha/directories/e2b2a65f-0972-4fb4-96bb-498a63411bb6/entries/partners/237ff0f4-e9d5-4be6-a21a-5c913836d523/",
  "id": "237ff0f4-e9d5-4be6-a21a-5c913836d523",
  "title": "The Best Partner",
  "headline": "The App headline.",
  "type": "string",
  "slug": "the-best-partner",
  "customSlug": "string",
  "status": "public",
  "icon": "https://image.domain.com/icon.png",
  "image": "https://image.domain.com/partner.png",
  "iconDark": "https://image.domain.com/icon-dark.png",
  "imageDark": "https://image.domain.com/partner-dark.png",
  "website": "https://the.partner.website.com",
  "featured": true,
  "owner": "7f80323b-dc05-4002-a2a0-89c627c2dc82",
  "userAssignedFilterOptions": "string",
  "systemAssignedFilterOptions": "string",
  "mappedAssignedFilterOptions": "string",
  "description": "The partner that you were waiting for!",
  "location": "Dublin, Dublin, Ireland",
  "callToActionUrl": "string",
  "callToActionLabel": "string",
  "externalUrl": "string",
  "externalId": "string",
  "resources": [
    {
      "id": "e4f88344-ec9d-438b-9e05-f2f4cc89ed88",
      "title": "Entry Resource",
      "file": null,
      "fileUrl": null,
      "url": "https://partner.domain.com/resource",
      "order": 0
    }
  ],
  "awards": [
    {
      "title": "string",
      "file": "string",
      "order": 1,
      "id": "string"
    }
  ],
  "supportEmail": "string",
  "developerName": "string",
  "contactRequestsHidden": true,
  "contactsRestricted": true,
  "certifications": "string",
  "badges": [
    {
      "href": "/api/directory/private/v1alpha/entries/partners/237ff0f4-e9d5-4be6-a21a-5c913836d523/badges/5a7d2c91-8e4b-4f36-a1c0-3b9e6d2f7a48/",
      "id": "5a7d2c91-8e4b-4f36-a1c0-3b9e6d2f7a48",
      "image": "https://example.com/media/badges/gold.png",
      "order": 0,
      "title": "Gold Partner"
    }
  ],
  "tracking": {
    "umamiWebsiteId": "string",
    "umamiShareId": "string",
    "umami_share_id": "1xdfagJ",
    "umami_website_id": "ed2faba6-7aec-459a-b997-97fcfc390709"
  },
  "approvalFlow": "string",
  "readyForReview": true,
  "isNew": true,
  "created": "2024-01-15T09:30:00Z",
  "tier": {
    "title": "Tier Test",
    "id": "a8216d76-beb5-4b10-a280-cb23fd031245",
    "entriesCount": 1,
    "entriesListUrl": "/api/directory/private/v1alpha/directories/efc35140-2c3f-4936-a3f8-b700ecafe6b5/tiers/a8216d76-beb5-4b10-a280-cb23fd031245/entries/",
    "default": false,
    "image": "https://images/tier-image.png",
    "order": 3
  },
  "verifications": [
    {
      "id": "5a4045d7-9dbb-49ee-9132-180665dcdc3b",
      "title": "A Verification"
    },
    {
      "id": "ada6a021-e996-4d12-85dd-1d5220f67da4",
      "title": "B Verification"
    }
  ],
  "media": [
    {
      "id": "6a5fc0f0-c938-4b4e-85c2-b895a90b000d",
      "title": "Media 1",
      "description": "Media 1 description",
      "order": 0,
      "pdfFileThumbnailUrl": "https://image.domain.com/partner.png",
      "url": "https://image.domain.com/partner.png",
      "file": "string",
      "type": "I"
    }
  ],
  "callouts": [
    {
      "href": "string",
      "name": "One Callout",
      "id": "68c18fe3-9450-44dd-bc57-b332c53ce069",
      "order": 0,
      "textColor": "635BFF",
      "backgroundColor": "E8E6FF"
    }
  ],
  "iconUrl": "https://image.domain.com/icon.png",
  "imageUrl": "https://image.domain.com/partner.png",
  "metaTitle": "The Best Partner: certified implementation partner",
  "metaDescription": null,
  "call_to_action_label": "Call to action Label",
  "call_to_action_url": "https://just.do.it.com/",
  "clients": [
    {
      "file": null,
      "fileUrl": null,
      "id": "e4f88344-ec9d-438b-9e05-f2f4cc89ed88",
      "order": 0,
      "title": "Client Entry",
      "url": "https://client.domain.com/client"
    }
  ],
  "contact_requests_hidden": false,
  "custom_slug": null,
  "developer_name": "The Best Partner Developer",
  "display_on_internal_directory": false,
  "embed_height": null,
  "embed_src": null,
  "embed_title": null,
  "external_url": "https://external.partner.url.com/",
  "metadata": {
    "external_id": "158a0557-8918-4311-bc57-fb5f69c093c1"
  },
  "special_offers": [
    {
      "file": null,
      "fileUrl": null,
      "id": "e4f88344-ec9d-438b-9e05-f2f4cc89ed88",
      "order": 0,
      "title": "Entry Special Offer",
      "url": "https://partner.domain.com/special-offer"
    }
  ],
  "support_email": "support@partner.website.com",
  "testimonials": [
    {
      "author_name": "John Doe",
      "company_name": "Company Inc.",
      "id": "134427f8-d25e-466a-806e-7145523a471e",
      "order": 0,
      "position": "Project Manager",
      "testimonial_text": "This is a great testimonial"
    }
  ],
  "use_cases": [
    {
      "description": "Use Case 1 description",
      "id": "aab920e3-a5da-4a59-89d6-44591ddea8ad",
      "order": 0,
      "title": "Use Case 1"
    }
  ]
}

Create new partner entry. The logo (image) and icon are optional base64 data URIs; without them the partner is created with no logo.

Authentication

AuthorizationToken

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

Path parameters

directoryIdstringRequiredformat: "uuid"

id of the directory

Request

This endpoint expects an object.

titlestringRequired1-256 characters

headlinestringRequired1-250 characters

descriptionstringRequired>=1 character

websitestringRequiredformat: "uri">=1 character

integrationDescriptionstring or nullOptional

statusenumOptionalDefaults to hidden

hidden - hidden
inactive - inactive
public - public
searchable - searchable

Allowed values:

tierstringOptionalformat: "uuid"

featuredbooleanOptionalDefaults to false

ownerstring or nullOptionalformat: "uuid"

profileFieldsmap from strings to anyOptional

Values of the directory’s profile fields by field key. An image or file field takes the URL that POST /api/core/private/v1alpha/files/ returned, or {url, name}

locationstring or nullOptional<=255 characters

imagestring or nullOptionalformat: "binary"

iconstring or nullOptionalformat: "binary"

iconUrlstring or nullOptionalformat: "uri">=1 character

imageUrlstring or nullOptionalformat: "uri">=1 character

imageDarkstring or nullOptionalformat: "binary"

iconDarkstring or nullOptionalformat: "binary"

displayOnInternalDirectorybooleanOptional

externalIdstring or nullOptional<=100 characters

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