Create CommunityPerk

POST

api

content

communityperks

curl --request POST \
  --url https://spaces.nexudus.com/api/content/communityperks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Title": "<string>",
  "DisplayOrder": 123,
  "ClickCount": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/content/communityperks"

payload = {
    "BusinessId": 123,
    "Title": "<string>",
    "DisplayOrder": 123,
    "ClickCount": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, Title: '<string>', DisplayOrder: 123, ClickCount: 123})
};

fetch('https://spaces.nexudus.com/api/content/communityperks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A CommunityPerk represents a perk, discount, or benefit that a location offers to its customers in partnership with other businesses. Perks can be discounts, free trials, or any other benefit negotiated with a partner business — for example, 50% off a car rental or a free hot drink at a nearby café. They are published on the Members Portal where customers can view and claim them. Use Active to control visibility — when false, the perk is only visible on the Admin Panel. Use ShowInHomePage to feature a perk on the Members Portal home page after users log in. Availability can be restricted via OnlyForContacts and OnlyForMembers. If neither flag is set, the perk is available to all customers. Use Tariffs to further restrict access to customers on specific pricing plans. Which perks are listed in a location is also controlled by the Access.Data.Perks BusinessSetting, whose value is an eDataVisibilityCriteria enum integer. This determines which locations’ perks are visible to customers at a given location — for example ThisLocationOnly (7) shows only perks belonging to the current location, while AllLocations (3) shows perks from all locations in the network.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CommunityPerk-Create role.

Enums

eDataVisibilityCriteria

Value	Name
1	AllChildren
2	AllParents
3	AllLocations
4	HomeLocationOnly
5	HomeLocationChildren
6	HomeLocationParents
7	ThisLocationOnly
8	AllParentChildren

Request Body

Required Fields

integer

required

ID of the location this perk belongs to.

string

required

Name of the perk as displayed on the Members Portal and the Admin Panel.

integer

required

Position of this perk in the list relative to other perks. Lower values appear first.

integer

required

Number of times customers have clicked on this perk.

Optional Fields

string

URL where customers are redirected when clicking the Claim button. If blank, no Claim button is shown. Must start with https://.

string

Short description shown under the perk title on the Perks listing page of the Members Portal.

string

Full description of the perk, displayed when a customer clicks on it from the Perks listing page.

string

URL of a new small image to upload for this perk.

boolean

Set to true to remove the current small image from this perk.

string

URL of a new large image to upload for this perk.

boolean

Set to true to remove the current large image from this perk.

boolean

Whether this perk is published and visible to customers on the Members Portal. When false, the perk is only visible on the Admin Panel.

string

Group or category this perk belongs to, used to organise perks on the Members Portal.

boolean

Whether to feature this perk on the Members Portal home page after users log in.

boolean

Whether this perk is only available to contacts. Set both OnlyForContacts and OnlyForMembers to false to make the perk available to all customers.

boolean

Whether this perk is only available to members. Set both OnlyForContacts and OnlyForMembers to false to make the perk available to all customers.

integer[]

IDs of the pricing plans (tariffs) whose members can see and claim this perk. Leave empty to make the perk available regardless of pricing plan.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/content/communityperks" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Title": "",
    "DisplayOrder": 0,
    "ClickCount": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/content/communityperks',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Title: '',
      DisplayOrder: 0,
      ClickCount: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/content/communityperks',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Title': '',
        'DisplayOrder': 0,
        'ClickCount': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the communityperk was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CommunityPerk was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Title: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Title"
    }
  ],
  "WasSuccessful": false
}

Update CommunityPerkUpdate an existing CommunityPerk record.

Create CommunityPerk

curl --request POST \
  --url https://spaces.nexudus.com/api/content/communityperks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Title": "<string>",
  "DisplayOrder": 123,
  "ClickCount": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/content/communityperks"

payload = {
    "BusinessId": 123,
    "Title": "<string>",
    "DisplayOrder": 123,
    "ClickCount": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, Title: '<string>', DisplayOrder: 123, ClickCount: 123})
};

fetch('https://spaces.nexudus.com/api/content/communityperks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400