Purpose of the "Links" section within Address API

Lindsey Bryant

Can someone explain to me what the point of the “Links” section is within the Create Address API Call?

My thinking was if I created an address for the student and included the parent User_IDs in the “links” section, it would automatically create the address on their record. This would ensure if a change was made on the Student's address record, it would update any record where the address was “linked”. However, the only thing I can see it does it allows someone through the User Interface only to then click “Add Address” and then select the address to be “linked”.

Is there not an API call that allows us to connect these without a user intervening?

https://api.sky.blackbaud.com/school/v1/users/{user_id}/addresses

{

"city": "City",

"country": "United States",

"line_one": "123 Main Street,

"line_two": "",

"line_three": "",

"mailing_address": true,

"postal_code": "12345",

"primary": true,

"province": "",

"region": "",

"state": "NY",

"type_id": 1111,

"user_id": 500007,

"links": [

{

"type_id": 1111,

"primary": true,

"shared": true,

"type": "Home",

"user_id": 5162515

},

{

"type_id": 1111,

"primary": true,

"shared": true,

"type": "Home",

"user_id": 5771016

}

]

}

Todd DeSchuiteneer

Hi @Lindsey Bryant, yes the Link section of that add address body should be posting the address to both records and creating that share link between them. I have tested and received the same results you did where the address posted to the main user but did not link to the secondary user in the body.

I will go ahead and create a support ticket for you and report the issue to our development team to have this resolved. In the future, if you find something isn't working as you think I encourage you to reach out to our support team to report the issue. Thank you!