Skip to main content
PATCH
/
api
/
v1
/
addresses
/
{id}
Update an 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": "Updated Address",
      "address_line1": "999 Updated St",
      "address_level1": "Updated City",
      "address_level2": "IL",
      "postal_code": "62799"
    }
  }
}'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "address",
    "attributes": {
      "custom_fields": {},
      "label": "<string>",
      "address_line1": "<string>",
      "address_line2": "<string>",
      "address_line3": "<string>",
      "address_level1": "<string>",
      "address_level2": "<string>",
      "address_level3": "<string>",
      "address_level4": "<string>",
      "country": "<string>",
      "country_name": "<string>",
      "postal_code": "<string>",
      "effective_from": "2023-12-25",
      "effective_to": "2023-12-25"
    },
    "relationships": {
      "profile": {
        "data": {
          "type": "profile",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "links": {
          "related": "<string>"
        },
        "meta": {}
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

Bearer token

Path Parameters

id
string
required

Address UUID

Body

application/vnd.api+json
data
object
required

Response

address updated

data
object
required
I