School

This API is used to provide access to school information such as users, academics, admissions, athletics, content, lists, and general school info.

PATCH

User update

Updates the record of a single user.
Returns the ID of the user just updated upon success.
Requires at least one of the following roles in the Education Management system:

  • Platform Manager
  • Page Manager
  • Content Editor

Try it

Request URL

Request headers

Header Required Type Description
Content-Type string Media type of the body sent to the API.
Bb-Api-Subscription-Key Property is required string Subscription key which provides access to this API. Found in your Profile.
Authorization Property is required string OAuth 2.0 access token obtained from Blackbaud OAuth 2.0 Service. Supported grant types: Authorization code, Implicit.

Request body

User information to be updated

{
  "id": 0,
  "affiliation": "string",
  "custom_field_eight": "string",
  "custom_field_five": "string",
  "custom_field_four": "string",
  "custom_field_nine": "string",
  "custom_field_one": "string",
  "custom_field_seven": "string",
  "custom_field_six": "string",
  "custom_field_ten": "string",
  "custom_field_three": "string",
  "custom_field_two": "string",
  "custom_field_10": "string",
  "custom_field_3": "string",
  "custom_field_2": "string",
  "custom_field_1": "string",
  "custom_field_4": "string",
  "custom_field_5": "string",
  "custom_field_6": "string",
  "custom_field_7": "string",
  "custom_field_8": "string",
  "custom_field_9": "string",
  "dob": "string",
  "deceased": true,
  "email": "string",
  "email_active": true,
  "first_name": "string",
  "gender": "string",
  "greeting": "string",
  "host_id": "string",
  "last_name": "string",
  "lost": true,
  "maiden_name": "string",
  "middle_name": "string",
  "nick_name": "string",
  "preferred_name": "string",
  "prefix": "string",
  "suffix": "string"
}
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID associated with a user",
      "format": "int32"
    },
    "affiliation": {
      "type": "string",
      "description": "The affiliation of a user",
      "nullable": true
    },
    "custom_field_eight": {
      "type": "string",
      "description": "A custom field on the user profile (eight of ten)",
      "nullable": true
    },
    "custom_field_five": {
      "type": "string",
      "description": "A custom field on the user profile (five of ten)",
      "nullable": true
    },
    "custom_field_four": {
      "type": "string",
      "description": "A custom field on the user profile (four of ten)",
      "nullable": true
    },
    "custom_field_nine": {
      "type": "string",
      "description": "A custom field on the user profile (nine of ten)",
      "nullable": true
    },
    "custom_field_one": {
      "type": "string",
      "description": "A custom field on the user profile (one of ten)",
      "nullable": true
    },
    "custom_field_seven": {
      "type": "string",
      "description": "A custom field on the user profile (seven of ten)",
      "nullable": true
    },
    "custom_field_six": {
      "type": "string",
      "description": "A custom field on the user profile (six of ten)",
      "nullable": true
    },
    "custom_field_ten": {
      "type": "string",
      "description": "A custom field on the user profile (ten of ten)",
      "nullable": true
    },
    "custom_field_three": {
      "type": "string",
      "description": "A custom field on the user profile (three of ten)",
      "nullable": true
    },
    "custom_field_two": {
      "type": "string",
      "description": "A custom field on the user profile (two of ten)",
      "nullable": true
    },
    "custom_field_10": {
      "type": "string"
    },
    "custom_field_3": {
      "type": "string"
    },
    "custom_field_2": {
      "type": "string"
    },
    "custom_field_1": {
      "type": "string"
    },
    "custom_field_4": {
      "type": "string"
    },
    "custom_field_5": {
      "type": "string"
    },
    "custom_field_6": {
      "type": "string"
    },
    "custom_field_7": {
      "type": "string"
    },
    "custom_field_8": {
      "type": "string"
    },
    "custom_field_9": {
      "type": "string"
    },
    "dob": {
      "type": "string",
      "description": "The birthday of a user",
      "format": "date-time"
    },
    "deceased": {
      "type": "boolean",
      "description": "Set to true if user is deceased"
    },
    "email": {
      "type": "string",
      "description": "The email address of a user",
      "nullable": true
    },
    "email_active": {
      "type": "boolean",
      "description": "Returns true if the users e-mail is ok to send to"
    },
    "first_name": {
      "type": "string",
      "description": "The first name of a user",
      "nullable": true
    },
    "gender": {
      "type": "string",
      "description": "The gender of a user",
      "nullable": true
    },
    "greeting": {
      "type": "string",
      "description": "The greeting of a user",
      "nullable": true
    },
    "host_id": {
      "type": "string",
      "description": "The HostId of a user",
      "nullable": true
    },
    "last_name": {
      "type": "string",
      "description": "The last name of a user",
      "nullable": true
    },
    "lost": {
      "type": "boolean",
      "description": "Set to true to mark user as being lost"
    },
    "maiden_name": {
      "type": "string",
      "description": "The maiden name of a user",
      "nullable": true
    },
    "middle_name": {
      "type": "string",
      "description": "The middle name of a user",
      "nullable": true
    },
    "nick_name": {
      "type": "string",
      "description": "The nickname of a user\r\n<b>This field will be deprecated after 90 days.</b>",
      "nullable": true
    },
    "preferred_name": {
      "type": "string",
      "description": "The preferred name of the user",
      "nullable": true
    },
    "prefix": {
      "type": "string",
      "description": "The prefix of a user",
      "nullable": true
    },
    "suffix": {
      "type": "string",
      "description": "The suffix of a user",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "UserEdit Model"
}

Response 200 OK

ID of the user just updated.

456123789
{
  "type": "integer",
  "format": "int64",
  "x-apim-inline": true
}

Code samples

@ECHO OFF

curl -v -X PATCH "https://api.sky.blackbaud.com/school/v1/users"
-H "Content-Type: application/json"
-H "Bb-Api-Subscription-Key: {subscription key}"
-H "Authorization: Bearer {access token}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }

        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Bb-Api-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "Bearer {access token}");

            var uri = "https://api.sky.blackbaud.com/school/v1/users?" + queryString;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               var request = new HttpRequestMessage(new HttpMethod("PATCH"), uri);
               request.Content = content;

               var response = await client.SendAsync(request);
            }

        }
    }
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.sky.blackbaud.com/school/v1/users");


            URI uri = builder.build();
            HttpPatch request = new HttpPatch(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Bb-Api-Subscription-Key", "{subscription key}");
            request.setHeader("Authorization", "Bearer {access token}");

            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity)); 
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/school/v1/users?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Bb-Api-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","Bearer {access token}");
            },
            type: "PATCH",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

    NSString* path = @"https://api.sky.blackbaud.com/school/v1/users";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];

    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PATCH"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Bb-Api-Subscription-Key"];
    [_request setValue:@"Bearer {access token}" forHTTPHeaderField:@"Authorization"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];

    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);

        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }

        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }

        NSLog(@"%@", json);
        _connectionData = nil;
    }

    [pool drain];

    return 0;
}
<?php
// This sample uses the PEAR HTTP client from http://pear.php.net/package/HTTP_Request2
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.sky.blackbaud.com/school/v1/users');
$url = $request->getUrl();

$headers = array(
    // Request headers
   'Content-Type' => 'application/json',
   'Bb-Api-Subscription-Key' => '{subscription key}',
   'Authorization' => 'Bearer {access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_PATCH);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Bb-Api-Subscription-Key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("PATCH", "/school/v1/users?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Bb-Api-Subscription-Key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("PATCH", "/school/v1/users?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.sky.blackbaud.com/school/v1/users')

request = Net::HTTP::Patch.new(uri.request_uri)

# Request headers
request['Content-Type'] = 'application/json'
request['Bb-Api-Subscription-Key'] = '{subscription key}'
request['Authorization'] = 'Bearer {access token}'

# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body

Comments

Have a question? See a problem with our docs? Want to engage with the SKY Developer team? Please visit us on the SKY Developer Community!