Update an address

Updates an address. Scoped to your integration’s institution via Basic Auth credentials.

PATCH/users/{id}/addresses/{addressId}

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters

idstringrequired

addressIdstringrequired

Request body

requiredapplication/json

addressstring

typestring

Allowed:homeworksecondary_homesemesterother

placeIdstring

Responses

200

Address updated

dataUserAddressrequired

Show properties

idstringrequired

addressstringrequired

typestringrequired

Allowed:homeworksecondary_homesemesterother

placeIdstring | null

createdAtstring<date-time>required

updatedAtstring<date-time>required

metaResponseMetarequired

Show properties

requestIdstringrequired

timestampstring<date-time>required

versionstringrequired

Allowed:v4

400

Bad Request

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

401

Unauthorized

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

404

Not Found

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

429

Too Many Requests

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

500

Internal Server Error

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Basic auth usernameBasic auth password

Remember on this deviceInclude my values in samples

Parameters

idpath*addressIdpath*

Bodyapplication/json

addressstringtypestringplaceIdstring

Request

curl -X PATCH 'https://fuxam.app/api/v4/users/string/addresses/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Content-Type: application/json' \
  -d '{
  "address": "string",
  "type": "home",
  "placeId": "string"
}'

const response = await fetch("https://fuxam.app/api/v4/users/string/addresses/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS",
    "Content-Type": "application/json"
  },
  body: "{\n  \"address\": \"string\",\n  \"type\": \"home\",\n  \"placeId\": \"string\"\n}"
});

import requests

response = requests.patch(
    "https://fuxam.app/api/v4/users/string/addresses/string",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS",
        "Content-Type": "application/json"
    },
    data="{\n  \"address\": \"string\",\n  \"type\": \"home\",\n  \"placeId\": \"string\"\n}",
)

Response

{
  "data": {
    "id": "string",
    "address": "string",
    "type": "home",
    "placeId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4"
  }
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}