Loading ...

REST API: Set Profile Field Visibility | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Users » REST API: Set Profile Field Visibility
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 26

REST API: Set Profile Field Visibility

0 
 /5
0 (0votes)
Open API Guide
POST/api/content/fields/visibility

Sets the visibility of a profile field for a specific user. ResponseData is true; the user's search index entry is refreshed afterwards.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
ContentIDIntegerYESQueryUser ID of the user whose field is updated. Must be the calling user unless the caller is a site administrator.
FieldUseIDIntegerYESQueryThe ID of the profile field
VisibilityIntegerYESQueryPublic = 0, Community (Intranet users) = 1, Private = 2, Connections = 3. A number outside 0 to 3 is accepted and saved as sent, with no error.

Optional Parameters

ParameterTypeRequiredLocationDescription
ContentTypeIDIntegerNOQueryNot used by this endpoint: the value is accepted and ignored. Default: 15.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/content/fields/visibility?ContentID=5&FieldUseID=66&Visibility=1

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": true
}

Error Response

{
  "Message": "No HTTP resource was found that matches the request URI 'https://your-site.com/api/content/fields/visibility?FieldUseID=77&Visibility=1'."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestContentID, FieldUseID, or Visibility is missing or not an integer (0 to 3 for Visibility).Send all three in the query string.
401 UnauthorizedA missing or invalid token answers 401 only on a site that allows members only; otherwise the call runs as a guest.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenContentID is another user and the caller is not a site administrator.Send your own user ID, or call as a site administrator.
500 Server ErrorInternal failure.Retry later.
404 or 405A required query parameter was left out, so the request matched a different action or none. The message reads No HTTP resource was found or The requested resource does not support http method.Send every required query parameter. The message does not mean the item you asked for is missing.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages