• Home
  • Documentation
    • Getting Started
    • Basics
    • Code Samples
  • Endpoint Reference
    • Academics
    • Admissions
    • Athletics
    • Constituents
    • Content
    • List
    • School Info
  • Tutorials
    • Testing in Postman
    • SSO Tutorial
  • Support
    • FAQ
    • Changelog
    • Community
    • Ideas
    • System Status
  • Home
  • Endpoint Reference
  • Constituents
  • Phone

Phone

GET Phone Types

Retrieves a list of all phone types available for the school. PhoneType.TypeId an important parameter for many phone requests.

GET Phone

Retrieves a list of phone for the userID and type provided. Data is returned based on Podium's profile publish settings.

GET Phone (Ignore profile publish settings)

Retrieves a list of phone for the userId and type provided. All phone data is returned regardles of publish settings.

GET Phone Shares

Retrives information about each instance this phone is shared to.

PUT Share Phone

Shares a phone ID with the indicated user ID as that type. Call fails when user ID already has a phone of that type.

PUT Phone

Updates the indicated phone to reflect the request data provided.

POST Phone

Adds a new phone for the indicated user ID as that type. Call fails if user ID already has a phone of that type.

DELETE Phone

Deletes a phone based on the supplied parameters. If user ID is not supplied, all shared instances of this phone will also be deleted. If user ID & type are supplied, only the specific shared instance will be deleted.

Blackbaud ON API

  • Documentation
  • Endpoint Reference
  • Tutorials
  • Support

© Blackbaud, Inc. All rights reserved.