Constituent

Monitor this page to keep up with the Constituent API latest changes and SKY API service releases.

2017-05-17

New

Added the following endpoint:

Operation Method Route
Action list (All constituents) GET /actions

2017-05-12

Changed

We added the comment property to the relationship entity.

2017-05-09

Changed

2017-04-25

New

Added the following endpoints:

Operation Method Route
Relationship POST /constituent/constituents/relationships
Relationship types GET /constituent/constituents/relationshiptypes
Organization contact types GET /constituent/constituents/organizationcontacttypes

Changed

GET operations such as Relationship list (Single constituent) that return relationship entities now return the following new properties:

Property Type Description
reciprocal_type string The reciprocal relationship type. Describes the constituent's relationship to the related constituent. For example, in a relationship between a male constituent and a female sibling, the reciprocal relationship type would be brother. Available values are the entries in the Relationships table.
is_spouse boolean Indicates whether the related constituent is the constituent's spouse. Only applies to relationships between individuals.
is_organization_contact boolean Indicates whether the related individual represents the organization as a contact. Only applies to relationships between organizations and individuals.
is_primary_business boolean Indicates whether the related organization is the individual's primary business. Only applies to relationships between organizations and individuals.
organization_contact_type string The contact type that provides context for interactions with the related individual who represents the organization as a contact. Available values are the entries in the Contact Types table. Only applies to relationships between organizations and individuals.
position string The individual's position in the organization. Only applies to relationships between organizations and individuals.

2017-04-20

Changed

  • The date_added parameter on the Constituent list endpoint now returns a sort_token on the next_link URL to enable pagination for stable data syncing.
  • The Constituent list endpoint now includes a sort parameter to sort constituents based on specified fields. For example, sort=date_modified,-last returns constituents in ascending order based on the date_modified field and then orders constituents with the same last-modified date in descending order based on their last names. If the sort parameter provides only the date_modified field or only the date_added field, then it returns a sort_token on the next_link URL.

2017-04-06

Changed

  • The Constituent list endpoint now populates the marital_status property by default.

February 2017

2017-02-23

Changed

  • The Constituent list endpoint now includes an optional custom_field_category parameter to retrieve constituents only if their active custom fields match specified custom field categories.
  • The Fundraiser list (Single constituent) endpoint now returns the appropriate value for the constituent_id field.

2017-02-09

Changed

  • The major and minor properties on the education entity have been updated to return an array of strings. They have been renamed majors and minors.
  • The subject_of_study property on the education entity is no longer returned in the major property. Instead, it uses a dedicated property for UK-formatted databases.
  • The Address (Create) endpoint no longer requires the country property. When country is not provided, the endpoint uses the organization's default country configuration.
  • The country property on the address entity now accepts a country ID, name, or abbreviation. The property uses preferential selection to match against ID first, then name, and then abbreviation.
  • The Ratings list (Single constituent) endpoint now includes an optional most_recent_only parameter to retrieve only the most recent rating for each category.

New

Added the following endpoints:

Operation Method Route
Countries (Get) GET /countries
Education (Create) POST /educations
Education (Edit) PATCH /educations/{education_id}
Education (Delete) DELETE /educations/{education_id}
Education schools (Get) GET /educations/schools
Education types (Get) GET /educations/types
Education statuses (Get) GET /educations/statuses
Education subjects (Get) GET /educations/subjects
Education degrees (Get) GET /educations/degrees
Education departments (Get) GET /educations/departments
Education degree classes (Get) GET /educations/degreeclasses
Education faculties (Get) GET /educations/faculties

January 2017

2017-01-31

Announcement: Breaking Changes Planned for Constituent API

We are updating some properties on the education entity to improve overall feature parity and to support upcoming POST and PATCH education endpoints in the Constituent API.

  • The major and minor properties will both be updated to return an array of strings. They will also be renamed majors and minors.
  • The subject_of_study property will no longer be returned in the major property. Instead, it will use a dedicated property for UK-formatted databases.

2017-01-11

Changed

On the Address (Create) endpoint, we updated the do_not_mail and preferred properties to set the default value to false when the properties are not supplied in the request body.

2017-01-10

Changed

We added the campus, known_name, and social_organization properties to the education entity.

2017-01-06

Changed

2016

2016-12-12

New

Added the following endpoint:

Operation Method Route
Rating category values (Get) GET /ratings/categories/values

Changed

2016-11-23

Changed

2016-11-16

Changed

The Constituent list endpoint now includes an option to filter constituents based on their associated constituent codes. The optional constituent_code query parameter returns constituents if any of the specified constituent codes match any of their active constituent codes. For example, constituent_code=Board Member&constituent_code=Volunteer returns constituents with either "Board Member" or "Volunteer" constituent codes.

2016-11-14

New

Added the following endpoints:

Operation Method Route
Constituent code list (All Constituents) GET /constituents/constituentcodes
Constituent custom field list (All constituents) GET /constituents/customfields

Changed

  • We renamed all existing list endpoints to implement a new naming convention that better indicates whether the endpoints return data for a single constituent or for all constituents. Endpoints that return data for a single constituent are now postfixed with (Single constituent). Endpoints that return data for all constituents are now postfixed with (All constituents).

  • The Address list (All constituents) endpoint no longer includes inactive addresses by default. To include inactive addresses, use the optional include_inactive parameter in the request.

  • The Address list (All constituents) endpoint now populates the formatted_address property.

  • We updated the following endpoints to appropriately respect constituent record-level security:

    Operation Method Route
    Address (List) GET /addresses
    Email address (List) GET /emailaddresses
    Online presence (List) GET /onlinepresences
    Phone (List) GET /phones

2016-10-20

New

Added the following endpoints:

Operation Method Route
Address (List)* GET /addresses
Email address (List)* GET /emailaddresses
Online presence (List)* GET /onlinepresences
Phone (List)* GET /phones

* The new endpoints assume the names of existing endpoints, which were renamed in the endpoint reference. The previous Address (List) is now Constituent address (List); the previous Email address (List) is now Constituent email address (List); the previous Online presence (List) is now Constituent online presence (List); and the previous Phone (List) is now Constituent phone (List).

Changed

We added the date_added and date_modified properties to the address, email address, online presence, and phone entities.

2016-10-17

Changed

The fundraisers property on the action entity now contains an array of strings populated with the constituent_id of fundraisers instead of an array of action fundraiser entities.

New

Added the following endpoints:

Operation Method Route
Action custom field (List) GET /actions/{action_id}/customfields
Action custom field (Create) POST /actions/customfields
Action custom field (Edit) PATCH /actions/customfields/{custom_field_id}
Action custom field (Delete) DELETE /actions/customfields/{custom_field_id}
Action custom field categories (Get) GET /actions/customfields/categories
Action custom field category values (Get) GET /actions/customfields/categories/values

2016-10-03

New

Added the following endpoints:

Operation Method Route
Prospect status (Get) GET /constituents/{constituent_id}/prospectstatus
Fundraiser (List) GET /constituents/{constituent_id}/fundraisers

2016-09-28

Changed

2016-09-27

Announcement: Breaking Changes Planned for Constituent API

We will change the fundraisers property on the action entity so that it contains a list of strings populated with the constituent_id of fundraisers instead of an array of action fundraiser entities.

2016-09-23

Announcement: Breaking Changes Planned for Constituent API

We will change the query string parameter includeInactive to include_inactive on the Constituent (List) endpoint.

2016-09-14

Announcement: Breaking Changes Planned for Constituent API

New

Added the following endpoints:

Operation Method Route
Rating sources (Get) GET /ratings/sources
Rating categories (Get) GET /ratings/categories
Action attachment (Edit) PATCH /actions/attachments/{attachmentId}
Action attachment (Delete) DELETE /actions/attachments/{attachmentId}
Constituent attachment (Edit) PATCH /constituents/attachments/{attachmentId}
Constituent attachment (Delete) DELETE /constituents/attachments/{attachmentId}

Changed

New tags included in the request will be automatically added to the Document Tags table when adding or updating attachments.

2016-09-07

New

Added the following endpoints:

Operation Method Route
Communication preference (Edit) PATCH /communicationpreferences/{communicationPreferenceId}
Rating (Create) POST /ratings
Rating (Edit) PATCH /ratings/{ratingId}
Rating (Delete) DELETE /ratings/{ratingId}

Changed

We added the lookup_id property to the search results entity.

2016-09-02

Changed

All POST endpoints now return a JSON object containing the id, in the form { "id": "123" }, instead of the previous string response.

2016-08-31

New

Added the following endpoints:

Operation Method Route
Action attachment (List) GET /actions/{actionId}/attachments
Action attachment (Create) POST /actions/attachments

Changed

2016-08-29

Announcement: Breaking Changes Planned for Constituent API

All POST endpoints will now return a JSON object containing the id, in the form { "id": "123" }, instead of the current string response.

2016-08-26

Changed

  • We renamed the proposal_id property to opportunity_id on actions to be consistent with product verbiage.

  • The Constituent (List) endpoint no longer includes inactive constituents by default. To include inactive constituents, use the optional includeInactive parameter in the request.

Announcement: Breaking Changes Planned for Constituent API

We will change the URL for the Constituent Attachment (Create) endpoint to /constituents/attachments.

2016-08-22

New

Added the following endpoints:

Operation Method Route
Currency configuration (Get) GET /currencyconfiguration

Changed

  • The data type assigned to the value property on the rating entity was changed from a string to an object. Previously, all values were returned as strings that needed to be parsed (by the requestor) into the intended types. Currently, the rating value will be returned with its data type intact based on the type with the following mapping:

    Type Description
    boolean Defines the rating value as a boolean JSON data type.
    codetable Defines the rating value as a string JSON data type that refers to a code table entry.
    currency Defines the rating value as a number JSON data type.
    datetime Defines the rating value as a string JSON data type in ISO-8601 format: 2015-09-18T00:00:00.
    number Defines the rating value as a number JSON data type.
    text Defines the rating value as a string JSON data type.
  • We corrected an issue with the postal_code filter within the Constituent (List) endpoint where incorrect values were returned if the postal codes filter listed multiple postal codes that were separated by commas or if postal codes contained leading space characters.

Announcement: Breaking Changes Planned for Constituent API

  • We will rename the constituent_id property to parent_id to support additional attachment areas such as action attachments.
  • We will rename the proposal_id property to opportunity_id on actions to be consistent with product verbiage.

2016-08-18

Announcement: Breaking Changes Planned for Constituent API

The Constituent (List) endpoint will no longer include inactive constituents by default. To include inactive constituents, use the optional includeInactive parameter in the request.

2016-08-16

Announcement: Breaking Changes Planned for Constituent API

The data type assigned to the value property on the rating entity will be changed from a string to an object. As it stands today, all values are returned as a string, which must then be parsed (by the requestor) into the intended type. After release, the Rating value will be returned with its data type intact.

2016-08-11

New

Added the following endpoints:

Operation Method Route
Communication preference (Create) POST /communicationpreferences
Communication preference (Delete) DELETE /communicationpreferences/{communicationPreferenceId}
Communication preferences (Get) GET /communicationpreferences

Changed

  • We added start and end to the communication preference entity to represent optional start and end dates.
  • We added the ability to retrieve inactive rating records by including a new, optional includeInactive parameter in the request.

2016-08-03

New

Added the following endpoints:

Operation Method Route
Communication preference (List) GET /constituents/{constituentId}/communicationpreferences

Changed

  • We removed boolean_value, code_table_value, constituent_id_value, date_value, fuzzy_date_value, currency_value, numeric_value, text_value and replaced them with a single value property for use with any type on the custom field entity.
  • We added the gpa, class_of_degree, faculty, department, and registration_number properties to the education entity.
  • We added the ability to paginate search results by including a new, optional limit and offset parameters in the request.
  • We added the ability to retrieve inactive address records by including a new, optional includeInactive parameter in the request.

2016-07-29

Announcement: Breaking Changes Planned for Constituent API

  • We will remove boolean_value, code_table_value, constituent_id_value, date_value, fuzzy_date_value, currency_value, numeric_value, text_value and replace them with a single value property for use with any type on the custom field entity.
  • This change is planned to take effect on Monday, August 1st.

2016-07-27

Added the following endpoints:

Operation Method Route
Constituent (Edit) PATCH /constituents/{constituentId}

2016-07-22

New

Added the following endpoints:

Operation Method Route
Rating (List) GET /constituents/{constituentId}/ratings/
Constituent custom field (Create) POST /constituents/customfields/
Constituent custom field (Edit) PATCH /constituents/customfields/{customFieldId}
Constituent custom field (Delete) DELETE /constituents/customfields/{customFieldId}
Constituent custom field category values (Get) GET /constituents/customfields/categories/values

Changed

We added the date_added, date_modified, title_2, suffix_2, marital_status, deceased_date properties to the constituent entity.

2016-07-18

New

Added the following endpoint:

Operation Method Route
Constituent (Create) POST /constituents

Changed

We removed the business property from the constituent entity.

2016-07-07

Changed

  • We renamed kind to type and types to tags on the attachment entity.
  • We renamed nickname to preferred_name on the constituent entity.

2016-07-01

New

Added the following endpoints:

Operation Method Route
First gift (Get) GET /constituents/{constituentId}/givingsummary/first
Latest gift (Get) GET /constituents/{constituentId}/givingsummary/latest
Greatest gift (Get) GET /constituents/{constituentId}/givingsummary/greatest
Constituent custom field categories (Get) GET /constituents/customfields/categories
Titles (Get) GET /titles
Suffixes (Get) GET /suffixes
Marital statuses (Get) GET /maritalstatuses

2016-06-30

Announcement: Breaking Changes Planned for Constituent API

  • We will rename kind to type and types to tags on the attachment entity.
  • We will rename nickname to preferred_name on the constituent entity.
  • This change is planned to take effect on Wednesday, July 6.

2016-06-27

New

  • Added the following endpoint:

    Operation Method Route
    Address (Edit) PATCH /addresses/{addressId}
  • Added the ability to retrieve inactive email address, online presence, and phone records by including a new, optional includeInactive parameter in the request.

2016-06-20

Changed

We updated the Constituent (List) endpoint to include a new, optional postal_code parameter which provides the ability to filter constituents by postal code based on their preferred address. The parameter value supports multiple postal codes separated by commas. Postal codes will match on a constituent if the preferred address postal code begins with one of the specified filter postal codes. For example, given the query postal_code=99577,10001, the response could contain constituents whose preferred address has a postal code of 99577-0727 or 10001.

2016-06-15

New

Added the following endpoint:

Operation Method Route
Address (Delete) DELETE /addresses/{addressId}

Changed

We added a versioning indicator to the Constituent API's base URL. Specifically, all new API requests must begin with https://api.sky.blackbaud.com/constituent/v1.

2016-06-10

Announcement: Breaking Changes Planned for Constituent API

  • We will be adding a versioning indicator to the Constituent API's base URL. Specifically, all new API requests should begin with https://api.sky.blackbaud.com/constituent/v1.
  • This change is planned to take effect on Wednesday, June 15.

2016-06-09

New

Added the following endpoint:

Operation Method Route
Address (Create) POST /addresses

2016-06-06

New

Added the following endpoints:

Operation Method Route
Lifetime giving (Get) GET /constituents/{constituentId}/givingsummary/lifetimegiving
Membership (List) GET /constituents/{constituentId}/memberships

2016-06-01

New

Added the following endpoints:

Operation Method Route
Action types (Get) GET /actiontypes
Action status types (Get) GET /actionstatustypes

2016-05-27

New

  • Added the following endpoints:

    Operation Method Route
    Note types (Get) GET /notetypes
  • Added a General Ledger changelog to help you keep up with General Ledger API changes.

2016-05-24

New

Added the following endpoints:

Operation Method Route
Address types (Get) GET /addresstypes

Changed

We renamed send_mail to do_not_mail on the address entity. Additionally, the boolean logic has been switched.

2016-05-20

Announcement: Breaking Changes Planned for Constituent API

  • We will rename send_mail to do_not_mail on the address entity. Additionally, the boolean logic will be switched.
  • We will remove the business property from the constituent entity.

New

Added the following endpoints:

Operation Method Route
Phone (Create) POST /phones
Phone (Edit) PATCH /phones/{phoneId}
Phone (Delete) DELETE /phones/{phoneId}
Phone types (Get) GET /phonetypes
Email address types (Get) GET /emailaddresstypes
Online presence types (Get) GET /onlinepresencetypes
Constituent code types (Get) GET /constituentcodetypes

Changed

We implemented the following breaking changes:

  • We removed the following address properties:
    • primary_business
    • start
    • end
    • seasonal
    • seasonal_start
    • seasonal_end
    • in_season
    • valid
  • We renamed the address to formatted_address.

2016-05-16

Announcement: Breaking Changes Planned for Constituent API

  • We will remove the following address properties:

    • primary_business
    • start
    • end
    • seasonal
    • seasonal_start
    • seasonal_end
    • in_season
    • valid
  • We will remove the business property from the constituent entity.

2016-05-13

New

  • We updated the Constituent (List) endpoint to include a new, optional date_added parameter which provides the ability to poll for recently added constituents since a specified date/time. The parameter value should consist of a URL encoded UTC datetime. When specified, the list is sorted by date added in ascending order.

  • We updated the Constituent (List) endpoint to include a new, optional last_modified parameter which provides the ability to poll for recently changed constituents since a specified date/time. The parameter value should consist of a URL encoded UTC datetime. When specified, the list is sorted by last modified in ascending order.

    The response includes a sort_token within the next_link property. sort_token represents a token filter for providing the next set of constituents, ordered by the last modified date.

    Note: The Constituent (List) endpoint returns data with an average latency of 30 minutes.

2016-05-06

New

  • Added the following granular address properties:

    • address_lines
    • city
    • suburb
    • state
    • postal_code
    • county
    • country

    Addresses are returned by the following endpoints:

    Operation Method Route
    Constituent (Get) GET /constituents/{constituentId}
    Constituent (List) GET /constituents
    Address (List) GET /constituents/{constituentId}/addresses
  • Added international address field support for the following countries.

    Field United States Canada United Kingdom Australia New Zealand
    address_lines
    city *
    suburb
    state !
    postal_code
    county
    country

    * Australia - City or suburb data is returned with the city field for GET operations. Future endpoints will allow you to POST and PATCH address data. In these cases, you can use either the suburb or city properties, but not both at the same time. Providing both property values in future POST and PATCH operations will result in an error.
    ! Canada - Use the state property to track a Canadian Province

Changed

  • For consistency, constituent_id is included in the following entities:

  • When editing, existing endpoints that previously used the PUT HTTP verb have been replaced with PATCH. PATCH can be used to update partial resources. For instance, when you only need to update one field of the resource. Impacted constituent related endpoints include:

    Operation New Method Route
    Action (Edit) PATCH /actions/{actionId}
    Constituent code (Edit) PATCH /constituentcodes/{constituentCodeId}
    Email address (Edit) PATCH /emailaddresses/{emailAddressId}
    Note (Edit) PATCH /notes/{noteId}
    Online presence (Edit) PATCH /onlinepresences/{onlinePresenceId}
  • We made changes to the custom field entity:

    • To better denote the fields that can represent the "value" of the custom field, we appended a _value suffix to the field name for the following fields:

      • constituent_id_value
      • date_value
      • text_value
      • number_value
      • currency_value
      • boolean_value
      • code_table_value
      • fuzzy_date_value
    • Renamed the constituent_id property to parent_id to avoid confusion with the constituent_id_value field and to facilitate the re-use of this type across other entities. The parent_id represents the parent object's identifier. For example, in the case of constituent custom fields, the parent_id represents the constituent identifier.

    • Added date and comment properties.

2016-04-26

Announcement: Breaking Changes Planned for Constituent API

In the coming days two breaking changes will be placed into effect:

  • We will replace existing PUT endpoints to use PATCH, instead. Unlike PUT, PATCH can be used to update partial resources. For instance, when you only need to update one field of the resource. In this way the payload size is optimized.

2016-04-25

New

  • Added the ability to create, edit, and delete email addresses:

    Operation Method Route
    Email address (Create) POST /emailaddresses
    Email address (Edit) PUT /emailaddresses/{emailAddressId}
    Email address (Delete) DELETE /emailaddresses/{emailAddressId}
  • Added the ability to create and edit constituent codes:

    Operation Method Route
    Constituent code (Create) POST /constituentcodes
    Constituent code (Edit) PUT /constituentcodes/{constituentCodeId}
    Constituent code (Delete) DELETE /constituentcodes/{constituentCodeId}

2016-04-15

New

Added the ability to create, edit, and delete online presence entities:

Operation Method Route
Online presence (Create) POST /onlinepresences
Online presence (Edit) PUT /onlinepresences/{onlinePresenceId}
Online presence (Delete) DELETE /onlinepresences/{onlinePresenceId}

2016-04-08

New

  • Added the ability to return a paginated list of constituents. For this release, the list will be ordered by name (last name for individuals, organization name for organizations).

    Operation Method Route
    Constituent (List) GET /constituents

    The endpoint supports the following the optional request parameters. Pagination is facilitated through the results via the top and skip parameters:

    Property Description
    top Optional. Integer. Represents the number of records to return. If not specified, the default is 100. The maximum allowed value is 500.
    skip Optional. Integer. Represents the number of records to skip.

Changed

  • Breaking change implemented for the Constituent API endpoints that return a collection of objects. This change allows us to be consistent in the representation of data collections and supports pagination for certain endpoints.

    See the 2016-03-31 changelog entry for a listing of affected endpoints.

  • Constituent (Search) now supports the ability to search on an email address (same functionality as found in the RE NXT search feature). This expanded search will match against constituent email addresses when the searchText parameter is a valid email address. Note that we currently support exact match only.

2016-03-31

Announcement: Breaking Changes Planned for Constituent API endpoints

In the coming weeks, we will be standardizing the shape of our responses that return a collection of objects. This standardization will allow us to be consistent across each endpoint as well as to facilitate some future enhancements around pagination within those endpoints. The new representation of a collection will be a JSON object with two properties, a count which represents the total number of records meeting the criteria and a value property which represents the array of items for the current paged response.

This change is scheduled for release by April 8, 2016.

How a collection response is formed today (Phones used as an example):

{
    "phones": [
        {
            "id": "95",
            "type": "Home",
            "number": "303-997-3301",
            "do_not_call": false,
            "primary": true,
            "inactive": false
        },
        {
            "id": "330",
            "type": "Home",
            "number": "(312) 997-3301",
            "do_not_call": false,
            "primary": false,
            "inactive": false
        }
    ]
}

How the response will be formed after release:

{
    "count": 10, // total number of elements in the collection
    "value": [   // collection of items included in this response
        {
            "id": "95",
            "type": "Home",
            "number": "303-997-3301",
            "do_not_call": false,
            "primary": true,
            "inactive": false
        },
        {
            "id": "330",
            "type": "Home",
            "number": "(312) 997-3301",
            "do_not_call": false,
            "primary": false,
            "inactive": false
        }
    ]
}

* Please note that the response format may change before official release.

Endpoints affected:

Operation Method Route
Action (List) GET /constituent/constituents/{constituentId}/actions
Address (List) GET /constituent/constituents/{constituentId}/addresses
Constituent attachment (List) GET /constituent/constituents/{constituentId}/attachments
Constituent code (List) GET /constituent/constituents/{constituentId}/constituentcodes
Constituent (Search) GET /constituent/constituents/search/?searchText={searchText}
Constituent custom field (List) GET /constituent/constituents/{constituentId}/customfields
Education (List) GET /constituent/constituents/{constituentId}/educations
Email address (List) GET /constituent/constituents/{constituentId}/emailaddresses
Name format (List) GET /constituent/constituents/{constituentId}/nameformats
Note (List) GET /constituent/constituents/{constituentId}/notes
Online presence (List) GET /constituent/constituents/{constituentId}/onlinepresences
Phone (List) GET /constituent/constituents/{constituentId}/phones
Relationship (List) GET /constituent/constituents/{constituentId}/relationships

2016-03-30

New

  • Added the ability to return a list of relationships for a specified constituent.

    Operation Method Route
    Relationship (List) GET /constituents/{constituentId}/relationships
  • Added the ability to return a constituent's profile picture.

    Operation Method Route
    Profile picture (Get) GET /constituents/{constituentId}/profilepicture

Changed

GET operations that return an attachment endpoint, such as Constituent attachment (List), return the following new properties:

Property Description
thumbnail_url Read only. String. Represents an image thumbnail URI for a picture to display. Endpoints that add or edit attachments ignore this property.
file_size Read only. Long integer. The file size of the attachment in bytes. Only applies to physical attachments. Helps to determine how to display large images. Endpoints that add or edit attachments ignore this property.

2016-03-10

New

  • Added the ability to return a list of education items for a specified constituent.

    Operation Method Route
    Education (List) GET /constituents/{constituentId}/educations
  • Added the ability to edit and delete actions and notes for a constituent:

    Operation Method Route
    Action (Edit) PUT /actions/{actionId}
    Action (Delete) DELETE /actions/{actionId}
    Note (Edit) PUT /notes/{noteId}
    Note (Delete) DELETE /notes/{noteId}

Changed

  • OAuth and Constituent API URLs changed. See Base URLs.

    • The route for the authorization endpoint is no longer prefixed with renxt.

      Operation Method Old Route New Route
      authorization (Get) GET /renxt/authorization /authorization
    • The base URL for the Constituent API has changed:

      Old New
      https://api.nxt.blackbaud-dev.com/constituents/ https://api.sky.blackbaud.com/constituent
  • After creating an attachment for a constituent, the returned representation of an attachment now includes the attachment identifier (id).

  • Values for the Constituent gender property now return the values using the correct casing (lowercase).

  • GET and POST routes for actions and notes endpoints have changed:

    Operation Method Old Route New Route
    Action (Get) GET /{constituentId}/actions/{actionId} /actions/{actionId}
    Action (Create) POST /{constituentId}/actions /actions
    Note (Get) GET /{constituentId}/notes/{noteId} /notes/{noteId}
    Note (Create) POST /{constituentId}/notes /notes

Deleted

We removed the following endpoints:

  • GET Attachment
  • GET Constituent code
  • GET Custom field
  • GET Email address
  • GET Online presence
  • GET Phone
  • GET Primary business
  • GET Spouse

2015

2015-10-20

New

Changed

  • Removed Author from the constituent note entity. The author is now inferred from the context of the user calling the SKY API.