List_
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- patchOnUserId() : bool
- Updates a list of admin custom field for a user.
- postToUserId() : bool
- Creates a list of admin custom field for a user.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/{user_id}/customfields/list"
Endpoint URL pattern
Methods
patchOnUserId()
Updates a list of admin custom field for a user.
public
patchOnUserId(array{user_id: int} $params, array<string|int, UserAdminCustomFieldUpdate> $requestBody) : bool
Requires at least one of the following roles in the Education Management system:
- Platform Manager
Parameters
- $params : array{user_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user to update an existing custom field for.
- $requestBody : array<string|int, UserAdminCustomFieldUpdate>
-
Object that describes the custom field that should be updated.
Tags
Return values
bool —Success
postToUserId()
Creates a list of admin custom field for a user.
public
postToUserId(array{user_id: int} $params, array<string|int, UserAdminCustomFieldCreate> $requestBody) : bool
Does not create any of the ten default custom fields, every user has those fields created for them by default. To update those fields see User Custom Field Values Update.
Requires at least one of the following roles in the Education Management system:
- Platform Manager
Parameters
- $params : array{user_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user to create a custom field for
- $requestBody : array<string|int, UserAdminCustomFieldCreate>
-
Object that describes the list of custom fields that will be created for the user.
Tags
Return values
bool —Success