Documentation

User extends BaseEndpoint
in package

Table of Contents

Properties

$url  : string

Methods

postToUserId()  : mixed
Activates an existing inactive or suggested emergency contact for a user. To add a new user emergency contact, add the correct relationship between users first.

Properties

$url

protected string $url = "https://api.sky.blackbaud.com/school/v1/users/{user_id}/emergencycontacts/user"

Endpoint URL pattern

Methods

postToUserId()

Activates an existing inactive or suggested emergency contact for a user. To add a new user emergency contact, add the correct relationship between users first.

public postToUserId(array{user_id: int} $params, EmergencyContactUserCreate $requestBody) : mixed

To add a non-user emergency contact please see the Emergency Contact Non-User Create route.

Requires at least one of the following roles in the Education Management system:

  • SKY API Data Sync
Parameters
$params : array{user_id: int}

An associative array

  • user_id: Format - int32. The ID of the user.
$requestBody : EmergencyContactUserCreate
Tags
throws
ArgumentException

if required parameters are not defined

Return values
mixed

Success


        
On this page

Search results