search

Profile - Name

This object contains changes to various name fields as well as pronouns and gender identity (if activated for capture) for a constituent.

hashtag
Data Sources

The changes in this feed can originate from several sources:

  • profile updates

  • signature system registration

  • signature system bio update

triangle-exclamation

Be really careful with this. While profile originating updates are behind username/password, name updates from other sources are not. Name chances can't be done casually so please confirm when and where appropriate.

hashtag
Quick Preview

Log in to admin. Go to System > Reports and find "Daily: Identity Updates"

This exercises the same API resource you're about to pull from and returns the data as a flat csv. The columns represent each key of each item in the returned object array.

hashtag
Timing

We recommend daily. You're welcome to pull more frequently, but it's probably not of much help.

hashtag
Workflow

The recommended flow puts the onus on you to call us back after you've processed change requests. You may find that inconvenient. The alternate approach puts all the handling responsibility on your shoulders from the moment of fetch - meaning there's no recourse if you drop or lose the changeset following the GET. Most clients have opted for the alternate approach for simplicity.

Recommended:

  • fetch a block

  • update your CRM system

  • for each record you've handled, add the changeId to a list

  • PUT that list to AlumnIQ so we can mark the changes as processed

Alternate:

  • fetch a block, setting markAsProcessed=true

  • update your CRM system

hashtag
API Resource

GET /sync/identity-change

Optional Filters (pick one):

  • changedOnDate - YYYY-MM-DD in campus local time. Mutually exclusive with changedSinceDate and xid. No limit on maximum number of records returned

  • changedSinceDate - YYYY-MM-DD in campus local time. Mutually exclusive with changedOnDate and xid. Maximum of 500 records returned. If exactly 500 records are returned, you may want to mark them processed and then re-run your request to check for more.

  • xid - Mutually exclusive with changedOnDate and changedSinceDate. Returns all unprocessed records with this xid, most recent first. No limit on maximum number of records returned.

Optional executor:

  • markAsProcessed - Whether or not to mark all selected change records as processed when they are selected.

PUT /sync/identity-change

  • (required) changeIdList - A comma-delimited list of changeId's that we should mark as processed. These are included in the response from a GET request

PreviousProfile - WorkNextProfile - Loopbacks

Last updated