Create an app entry

POST

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

POST

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

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

{
  "href": "/api/directory/private/v1alpha/directories/e2b2a65f-0972-4fb4-96bb-498a63411bb6/entries/apps/674ec7e0-5812-4514-acef-4aecf5eb5873/",
  "id": "674ec7e0-5812-4514-acef-4aecf5eb5873",
  "title": "The Best App",
  "headline": "The App headline.",
  "type": "app",
  "slug": "the-best-app",
  "customSlug": "string",
  "status": "hidden",
  "icon": "http://localhost:8002/media/directories/icons/aed130bc-9ca3-40fb-8545-3c3a92a02f8e/image.jpg",
  "image": null,
  "iconDark": null,
  "imageDark": null,
  "website": "https://the.app.website.com",
  "featured": true,
  "owner": "454a6667-02d2-4a6b-9a04-97502dd23e2e",
  "userAssignedFilterOptions": "string",
  "systemAssignedFilterOptions": "string",
  "mappedAssignedFilterOptions": "string",
  "tier": {
    "title": "string",
    "id": "string",
    "entriesCount": 1,
    "entriesListUrl": "string"
  },
  "iconUrl": "http://localhost:8002/media/directories/icons/aed130bc-9ca3-40fb-8545-3c3a92a02f8e/image.jpg",
  "imageUrl": null,
  "callouts": [
    {
      "href": "string",
      "name": "One Callout",
      "id": "68c18fe3-9450-44dd-bc57-b332c53ce069",
      "order": 0,
      "textColor": "635BFF",
      "backgroundColor": "E8E6FF"
    }
  ],
  "assignedFilterOptions": [
    {
      "filterId": "bb79b73a-923f-4bc6-8e5e-8fc326e5d789",
      "href": "/api/directory/private/v1alpha/directories/969d9b77-c063-4101-b534-63071317ddbd/filters/15cbf8e9-2758-4009-b800-6db08e9b9359/options/de1f695f-f4f1-4699-8989-246377d14aed/",
      "id": "de1f695f-f4f1-4699-8989-246377d14aed",
      "image": "https://image.domain.com/option-2.png",
      "name": "option-2",
      "order": 1,
      "slug": "option-2"
    }
  ],
  "certifications": [
    {
      "id": "b2a0414d-f05d-4f34-a2f3-990116b9cdfd",
      "quantity": 14,
      "title": "Certification 3 (order 0)"
    },
    {
      "id": "8fb8379e-7049-4bb9-95d4-a3017d235789",
      "quantity": 14,
      "title": "Certification 1 (order 1)"
    },
    {
      "id": "85929f1d-10e3-459a-8e2d-622ed16d5110",
      "quantity": 1,
      "title": "Certification 2 (order 2)"
    }
  ],
  "custom_slug": null,
  "verifications": [
    {
      "id": "5a4045d7-9dbb-49ee-9132-180665dcdc3b",
      "title": "A Verification"
    },
    {
      "id": "ada6a021-e996-4d12-85dd-1d5220f67da4",
      "title": "B Verification"
    }
  ]
}

Create new app entry

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

websitestring or nullRequiredformat: "uri">=1 character

statusenumRequired

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

Allowed values:

descriptionstring or nullOptional

iconstring or nullOptionalformat: "binary"

imagestring or nullOptionalformat: "binary"

iconUrlstring or nullOptionalformat: "uri">=1 character

imageUrlstring or nullOptionalformat: "uri">=1 character

featuredbooleanOptionalDefaults to false

customSlugstring or nullOptional

userAssignedFilterOptionslist of stringsOptional

tierstringOptionalformat: "uuid"

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

tierobject or null

lastModifiedobject or nullOptional

Serializer for last_modified info including timestamp and user details.

descriptionstring or nullOptional

iconUrlstring or nullOptionalformat: "uri"

imageUrlstring or nullOptionalformat: "uri"

calloutslist of objectsOptional

Errors

404

Not Found Error