Skip to content
API Reference/
/
Delete a Personalization...

Foleon API (1.0.0)

The Foleon API enables you to quickly and easily develop functional applications or integrations. In fact, this is the same API that powers the Foleon platform itself.

The API follows RESTful principles, so if you've worked with a RESTful API before, many of its concepts will be familiar to you. It leverages standard HTTP features, making it compatible with most HTTP clients. Most responses, including errors, are returned in JSON format.

Designed for clarity and ease of use, the API adheres to standard HTTP response codes, providing detailed error messages when necessary.

Download OpenAPI description
index.json
index.yaml
Overview
License
Proprietary
Languages
Servers
EU cluster
https://api.foleon.com/
US cluster
https://api.us.foleon.com/

Authentication

Authenticate your requests using your api credentials by creating a bearer token.

Operations

Docs

All endpoints related to creating, retrieving or deleting Docs (editions), or updating their settings.

Operations

Projects

All endpoints related to Projects (titles).

Operations

Users

All endpoints related to Users.

Operations

Workspaces

All endpoints related to Workspaces (accounts).

Operations

Personalization Categories

All endpoints related to Personalization Categories.

Operations

Personalization Options

All endpoints related to Personalization Options.

Operations

Personalization Properties

All endpoints related to Personalization Properties.

Operations

Retrieve a Personalization Property

Request

Get a Personalization Property resource by it's ID.

Security
BearerAuth
Path
property_idinteger(ResourceIdSchema)required

The resource ID of the Personalization Property

Example: 123456789
curl -i -X GET \
  https://api.foleon.com/personalization/property/123456789 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

JSON response for a Personalization Property resource

Bodyapplication/json
_embeddedobject
_linksobject
created_onstring(date-time)
defaultstring
external_mappingstring or null
idinteger(ResourceIdSchema)
identifierstring
modified_onstring or null(date-time)
namestring
optionsobject
statusstring
Enum"active""archived"
typestring
Enum"text""dropdown_select"
Response
application/json
{
  "_embedded": {
    "account": { … },
    "category": { … }
  },
  "_links": {
    "self": { … }
  },
  "created_on": "2019-08-24T14:15:22Z",
  "default": "string",
  "external_mapping": "string",
  "id": 123456789,
  "identifier": "string",
  "modified_on": "2019-08-24T14:15:22Z",
  "name": "string",
  "options": {},
  "status": "active",
  "type": "text"
}

Update a Personalization Property

Request

Update a Personalization Property's settings.

Security
BearerAuth
Path
property_idinteger(ResourceIdSchema)required

The resource ID of the Personalization Property

Example: 123456789
Bodyapplication/jsonrequired

Updated Personalization Property attributes in JSON. Only the listed attributes can be updated. Not all of them have to be included in the request body.

namestring<= 200 characters^[A-Za-z\s]+$

Name of the personalization property.

categorystring

Reference to a Personalization Category.

defaultstring<= 200 characters

Default value for the personalization property.

statusstring

Status of the personalization property.

Enum"active""archived"
external_mappingArray of objects

External mapping structure for personalization property.

curl -i -X PATCH \
  https://api.foleon.com/personalization/property/123456789 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "category": "string",
    "default": "string",
    "status": "active",
    "external_mapping": [
      {}
    ]
  }'

Responses

JSON response for a Personalization Property resource

Bodyapplication/json
_embeddedobject
_linksobject
created_onstring(date-time)
defaultstring
external_mappingstring or null
idinteger(ResourceIdSchema)
identifierstring
modified_onstring or null(date-time)
namestring
optionsobject
statusstring
Enum"active""archived"
typestring
Enum"text""dropdown_select"
Response
application/json
{
  "_embedded": {
    "account": { … },
    "category": { … }
  },
  "_links": {
    "self": { … }
  },
  "created_on": "2019-08-24T14:15:22Z",
  "default": "string",
  "external_mapping": "string",
  "id": 123456789,
  "identifier": "string",
  "modified_on": "2019-08-24T14:15:22Z",
  "name": "string",
  "options": {},
  "status": "active",
  "type": "text"
}

Delete a Personalization Property

Request

WARNING: Deleting a Personalization Property is permanent and cannot be undone. Using this endpoint is risky.

Security
BearerAuth
Path
property_idinteger(ResourceIdSchema)required

The resource ID of the Personalization Property

Example: 123456789
curl -i -X DELETE \
  https://api.foleon.com/personalization/property/123456789 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Deletion was successful

List Personalization Properties

Request

Query all Personalization Properties available in your scope to return a list of Personalization Properties. Use bracket notation in the parameters to filter and order the data.

Security
BearerAuth
Query
filter[0][field]string(FilterFieldParameterSchema)

The field to filter on

Example: filter[0][field]=id
filter[0][type]string(FilterTypeParameterSchema)

The type of filtering operation

Enum"eq""neq""lt""lte""gt""gte""isnull""isnotnull"
filter[0][value]string or integer(FilterValueParameterSchema)

The value to filter on

Example: filter[0][value]=123456789
order-by[0][field]string(OrderByFieldParameterSchema)

The field to sort by

Example: order-by[0][field]=created_on
order-by[0][type]string(OrderByTypeParameterSchema)

a fixed value

Value"field"
order-by[0][direction]string(OrderByDirectionParameterSchema)

Descending or ascending.

Enum"desc""asc"
curl -i -X GET \
  'https://api.foleon.com/personalization/property?filter%5B0%5D%5Bfield%5D=id&filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bvalue%5D=123456789&order-by%5B0%5D%5Bfield%5D=created_on&order-by%5B0%5D%5Btype%5D=field&order-by%5B0%5D%5Bdirection%5D=desc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

JSON response for a list of Personalization Properties. Additionally, it contains handy query information and href links to help navigate pagination.

Bodyapplication/json
_linksobject
page_countinteger
page_sizeinteger
total_itemsinteger
pageinteger
countinteger
totalinteger
_embeddedobject
Response
application/json
{
  "_links": {
    "self": { … },
    "first": { … },
    "last": { … }
  },
  "page_count": 0,
  "page_size": 0,
  "total_items": 0,
  "page": 0,
  "count": 0,
  "total": 0,
  "_embedded": {
    "property": [ … ]
  }
}

Create a Personalization Property

Request

Create a new Personalization Property.

Security
BearerAuth
Bodyapplication/jsonrequired
accountobjectrequired
account.​idinteger
categoryobjectrequired
category.​idinteger
defaultstring
identifierstringrequired
namestringrequired
typestringrequired
Enum"dropdown_select""text"
statusstringrequired
Value"active"
curl -i -X POST \
  https://api.foleon.com/personalization/property \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "account": {
      "id": 0
    },
    "category": {
      "id": 0
    },
    "default": "string",
    "identifier": "string",
    "name": "string",
    "type": "dropdown_select",
    "status": "active"
  }'

Responses

JSON response for a Personalization Property resource

Bodyapplication/json
_embeddedobject
_linksobject
created_onstring(date-time)
defaultstring
external_mappingstring or null
idinteger(ResourceIdSchema)
identifierstring
modified_onstring or null(date-time)
namestring
optionsobject
statusstring
Enum"active""archived"
typestring
Enum"text""dropdown_select"
Response
application/json
{
  "_embedded": {
    "account": { … },
    "category": { … }
  },
  "_links": {
    "self": { … }
  },
  "created_on": "2019-08-24T14:15:22Z",
  "default": "string",
  "external_mapping": "string",
  "id": 123456789,
  "identifier": "string",
  "modified_on": "2019-08-24T14:15:22Z",
  "name": "string",
  "options": {},
  "status": "active",
  "type": "text"
}

Personalization Values

All endpoints related to Personalization Values.

Operations

Personalization Tokens

All endpoints related to Personalization Tokens.

Operations

Editing Content

All endpoints related to editing the content of you Foleon Docs.

Operations

Exporting Gzipped Docs

Export tar.gz webpackages to host Foleon Docs on your own server.

Operations

Foleon Analytics

All endpoints related to Foleons native analytics.

Operations

Media Library

All endpoints related to managing media in Foleon's media library.

Operations
Copyright © Foleon B.V. All rights reserved.