Addresses

Update an address

Input only the fields you want to update

patch/v1/addresses/{id}

Request

Base URL
(relative, and it does not resolve against the document’s source URL)
Auth
- API key in header sessionKey
- or API key in header clientCode
- or API key in header jwt
TypeScript
https://skmtc.dev/erply/apis/crm-api/docs/v1/addresses/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

idinteger required

address Id

address2string

Street address, line 2. This field is exposed via Erply user interface only for US, CA and MX accounts!

citystring

countrystring

customerIdinteger

postCodestring

Postal code or ZIP code.

statestring

State. This field is exposed via Erply user interface only for US, CA and MX accounts!

streetstring

Street address. If address cannot be split into parts, put the whole address into this field.

typeIdinteger

{
  "city": "Spring",
  "country": "US",
  "postCode": "77386",
  "state": "TX",
  "street": "3757  Richland Avenue"
}

idinteger

{
  "id": 73
}

No recorded changes to this operation across all 1 revision of this API.