Update Addresses#

Update the settings of a single Address owned by your account.

Request#

HTTP Method: PATCH

URI Path: /v3/addresses/

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique ID number allocated to this Address.

Attributes#

Name

Type

Is Required?

Description

city_name

string

No

City name of the address.

postal_code

string

No

Postal code of the address.

address

string

No

Full address.

description

string

No

The description of the address.

Examples#

http

 1PATCH /v3/addresses/46e129f1-deaa-44db-8915-2646de4d4c70 HTTP/1.1
 2Host: api.didww.com
 3Content-Type: application/vnd.api+json
 4Accept: application/vnd.api+json
 5Api-Key: [API token]
 6
 7{
 8  "data": {
 9    "id": "46e129f1-deaa-44db-8915-2646de4d4c70",
10    "type": "addresses",
11    "attributes": {
12      "city_name": "string",
13      "postal_code": "string",
14      "address": "string",
15      "description": "string"
16    }
17  }
18}

curl

1curl -i -X PATCH https://api.didww.com/v3/addresses/46e129f1-deaa-44db-8915-2646de4d4c70 -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"address": "string", "city_name": "string", "description": "string", "postal_code": "string"}, "id": "46e129f1-deaa-44db-8915-2646de4d4c70", "type": "addresses"}}'

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
 7    "type": "addresses",
 8    "attributes": {
 9      "city_name": "string",
10      "postal_code": "string",
11      "address": "string",
12      "description": "string",
13      "created_at": "2020-09-16T10:23:07.846Z"
14    },
15    "relationships": {
16      "identity": {
17        "links": {
18          "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/identity",
19          "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/identity"
20        }
21      },
22      "country": {
23        "links": {
24          "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/country",
25          "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/country"
26        }
27      },
28      "proofs": {
29        "links": {
30          "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/proofs",
31          "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/proofs"
32        }
33      },
34      "area": {
35        "links": {
36          "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/area",
37          "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/area"
38        }
39      },
40      "city": {
41        "links": {
42          "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/city",
43          "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/city"
44        }
45      }
46    }
47  },
48  "meta": {
49    "api_version": "2022-05-10"
50  }
51}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized