Update Addresses

Description

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

Optional

City name of the address.

postal_code

string

Optional

Postal code of the address.

address

string

Optional

Full address.

description

string

Optional

The description of the address.

Examples

http

PATCH /v3/addresses/46e129f1-deaa-44db-8915-2646de4d4c70 HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "id": "46e129f1-deaa-44db-8915-2646de4d4c70",
    "type": "addresses",
    "attributes": {
      "city_name": "string",
      "postal_code": "string",
      "address": "string",
      "description": "string"
    }
  }
}

curl

curl -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

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
        "type": "addresses",
        "attributes": {
            "city_name": "string",
            "postal_code": "string",
            "address": "string",
            "description": "string",
            "created_at": "2020-09-16T10:23:07.846Z"
        },
        "relationships": {
            "identity": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/identity",
                    "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/identity"
                }
            },
            "country": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/country",
                    "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/country"
                }
            },
            "proofs": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/proofs",
                    "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/proofs"
                }
            },
"area": {
  "links": {
    "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/area",
    "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/area"
  }
},
"city": {
  "links": {
    "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/city",
    "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/city"
  }
}
        }
    },
    "meta": {
        "api_version": "2021-04-19"
    }
}

Other Responses

Code

Success

Description

404

No

Not Found

401

No

Unauthorized