Update CommunityPerk

PUT

api

content

communityperks

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Id: 123, BusinessId: 123, Title: '<string>', DisplayOrder: 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>"
    }
  ]
}

Updates an existing CommunityPerk record. You must include the Id of the record to update along with all required fields.

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-Edit 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

The Id of the CommunityPerk record to update.

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.

Optional Fields

string

Optional URL opened when a customer uses the Claim button; leave blank to omit the button.

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 to exclude members and show this perk only to contacts, who have no active contract; do not set this and OnlyForMembers together.

boolean

Whether to exclude contacts and show this perk only to members, who have an active contract; do not set this and OnlyForContacts together.

integer[]

List of plan IDs eligible for this perk when a customer is a member; an empty list does not restrict members by plan, and contacts are not checked against this list.

integer[]

IDs added to the Tariffs relationship..

integer[]

IDs removed from the Tariffs relationship..

Code Examples

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

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

const data = await response.json();

import requests

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

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the communityperk was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CommunityPerk was successfully updated.",
  "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 CommunityPerk

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Id: 123, BusinessId: 123, Title: '<string>', DisplayOrder: 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