Share
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- postToUserId() : int
- For an existing user, create a link to an existing address.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/{user_id}/addresses/share"
Endpoint URL pattern
Methods
postToUserId()
For an existing user, create a link to an existing address.
public
postToUserId(array{user_id: int} $params, AddressShare $requestBody) : int
Returns the ID of the address just shared.
Requires at least one of the following roles in the Education Management system:
-
Contact Card Manager
-
Platform Manager
-
SKY API Data Sync
Parameters
- $params : array{user_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user the existing address should be shared.
- $requestBody : AddressShare
-
The details about the address that should be shared with the user.
Tags
Return values
int —ID of the address just shared.