Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Bearer token
Path Parameters
Address UUID
Body
application/vnd.api+json
Response
address updated
curl --request PATCH \
--url https://api.scholarlysoftware.com/api/v1/addresses/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "address",
"attributes": {
"label": "Office Address",
"external_id": "EXT-12345",
"address_line1": "789 Academic Dr",
"address_line2": "Suite 200",
"address_line3": "<string>",
"address_level1": "IL",
"address_level2": "Springfield",
"address_level3": "<string>",
"address_level4": "<string>",
"country": "US",
"country_name": "United States",
"postal_code": "62703",
"effective_from": "2024-01-01"
},
"relationships": {
"profile": {
"data": {
"type": "profile",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
}
}'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "address",
"attributes": {
"custom_fields": {},
"label": "Office Address",
"external_id": "EXT-12345",
"address_line1": "789 Academic Dr",
"address_line2": "Suite 200",
"address_line3": "<string>",
"address_level1": "IL",
"address_level2": "Springfield",
"address_level3": "<string>",
"address_level4": "<string>",
"country": "US",
"country_name": "United States",
"postal_code": "62703",
"effective_from": "2024-01-01",
"effective_to": "2023-12-25"
},
"relationships": {
"profile": {
"links": {
"related": "<string>"
},
"meta": {},
"data": {
"type": "profile",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
}
}Updates a specific address
curl --request PATCH \
--url https://api.scholarlysoftware.com/api/v1/addresses/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "address",
"attributes": {
"label": "Office Address",
"external_id": "EXT-12345",
"address_line1": "789 Academic Dr",
"address_line2": "Suite 200",
"address_line3": "<string>",
"address_level1": "IL",
"address_level2": "Springfield",
"address_level3": "<string>",
"address_level4": "<string>",
"country": "US",
"country_name": "United States",
"postal_code": "62703",
"effective_from": "2024-01-01"
},
"relationships": {
"profile": {
"data": {
"type": "profile",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
}
}'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "address",
"attributes": {
"custom_fields": {},
"label": "Office Address",
"external_id": "EXT-12345",
"address_line1": "789 Academic Dr",
"address_line2": "Suite 200",
"address_line3": "<string>",
"address_level1": "IL",
"address_level2": "Springfield",
"address_level3": "<string>",
"address_level4": "<string>",
"country": "US",
"country_name": "United States",
"postal_code": "62703",
"effective_from": "2024-01-01",
"effective_to": "2023-12-25"
},
"relationships": {
"profile": {
"links": {
"related": "<string>"
},
"meta": {},
"data": {
"type": "profile",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer token
Address UUID
Show child attributes
address updated
Show child attributes