Address updated

This event occurs when an address information changes.
Generated by: Update address
More information: Address and phone objects

Type: object
Domain: audit
Event: address_change
Version: 1

|
method required

Title: The HTTP Method of address updater operation
Type: string
Example:
PATCH

uri required

Title: The URI of address updater operation
Type: string
Example:
/v1/accounts/{accountId}/addresses/{addressId}

email required

Title: The email of operator that updated address
Type: string
Example:
[email protected]

roles required

Type: array

origin required

Title: The request origin of address updater operation
Type: string
Example:
APP
CRM

object required

Title: The object that represents the address update requested
Type: object

zip_code required

Title: The address zip code of account
Type: string or null
Example:
00000-000

country required

Title: The address country of account
Type: string or null
Example:
Brazil

address required

Title: The address of account
Type: string or null
Example:
Some St.

city required

Title: The address city of account
Type: string or null
Example:
São Paulo

address_type required

Title: The address type of account
Type: string or null
Example:
RESIDENTIAL

active required

Title: Indicates if account address is active
Type: boolean or null
Example:
false
true

creation_date required

Title: The address creation date
Type: string or null
Example:
2019-10-18T18:26:28+0000

org_id required

Title: The organization identifier of account
Type: string
Example:
TN-9dd08b9e-38fd-4359-949f-b33c3ea0d950

number required

Title: The address number of account
Type: integer or null
Example:
456

account_id required

Title: The account identifier of address
Type: integer
Example:
32422

complementary_address required

Title: The complementary address of account
Type: string or null
Example:
Apto. 11

mailing_address required

Title: The mailing address of account
Type: boolean
Example:
false
true

last_update required

Title: The last update of account address
Type: string or null
Example:
2019-10-18T18:26:28+0000

id required

Title: The address identifier
Type: integer
Example:
6869356

neighborhood required

Title: The address neighborhood of account
Type: string or null
Example:
Random Estates

state required

Title: The address state of account
Type: string or null
Example:
SP

customer_ids

Type: array or null

custom_fields

Title: Custom fields
Description: Metadata field with any key-value pairs.
Type: object or null
Example:

{
    "value_1": 800,
    "value_2": "17f43184-f1b5-4bac-9fba-49e2d178d1a4"
}
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Address updated",
    "description": "This event occurs when an address information changes. \n Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/patch-accounts-v1-accounts-accountid-addresses-addressid' target='_blank'>Update address</a> \n More information: <a href='https://developers.pismo.io/pismo-docs/docs/address-and-phone-objects' target='_blank'>Address and phone objects</a>",
    "required": [
        "method",
        "uri",
        "email",
        "roles",
        "origin",
        "object"
    ],
    "properties": {
        "method": {
            "type": "string",
            "title": "The HTTP Method of address updater operation",
            "examples": [
                "PATCH"
            ]
        },
        "uri": {
            "type": "string",
            "title": "The URI of address updater operation",
            "examples": [
                "/v1/accounts/{accountId}/addresses/{addressId}"
            ]
        },
        "email": {
            "type": "string",
            "title": "The email of operator that updated address",
            "examples": [
                "[email protected]"
            ]
        },
        "roles": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "title": "The roles of operator that updated address",
            "examples": [
                "test1",
                "test2"
            ]
        },
        "origin": {
            "type": "string",
            "title": "The request origin of address updater operation",
            "examples": [
                "APP",
                "CRM"
            ]
        },
        "object": {
            "type": "object",
            "title": "The object that represents the address update requested",
            "required": [
                "org_id",
                "account_id",
                "id",
                "zip_code",
                "country",
                "address",
                "city",
                "address_type",
                "active",
                "creation_date",
                "number",
                "complementary_address",
                "mailing_address",
                "last_update",
                "neighborhood",
                "state"
            ],
            "properties": {
                "zip_code": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "The address zip code of account",
                    "examples": [
                        "00000-000"
                    ]
                },
                "country": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "The address country of account",
                    "examples": [
                        "Brazil"
                    ]
                },
                "address": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "The address of account",
                    "examples": [
                        "Some St."
                    ]
                },
                "city": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "The address city of account",
                    "examples": [
                        "S\u00e3o Paulo"
                    ]
                },
                "address_type": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "The address type of account",
                    "examples": [
                        "RESIDENTIAL"
                    ]
                },
                "active": {
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "title": "Indicates if account address is active",
                    "examples": [
                        false,
                        true
                    ]
                },
                "creation_date": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "The address creation date",
                    "examples": [
                        "2019-10-18T18:26:28+0000"
                    ]
                },
                "org_id": {
                    "type": "string",
                    "title": "The organization identifier of account",
                    "examples": [
                        "TN-9dd08b9e-38fd-4359-949f-b33c3ea0d950"
                    ]
                },
                "number": {
                    "type": [
                        "integer",
                        "null"
                    ],
                    "title": "The address number of account",
                    "examples": [
                        456
                    ]
                },
                "account_id": {
                    "type": "integer",
                    "title": "The account identifier of address",
                    "examples": [
                        32422
                    ]
                },
                "complementary_address": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "The complementary address of account",
                    "examples": [
                        "Apto. 11"
                    ]
                },
                "mailing_address": {
                    "type": "boolean",
                    "title": "The mailing address of account",
                    "examples": [
                        false,
                        true
                    ]
                },
                "last_update": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "The last update of account address",
                    "examples": [
                        "2019-10-18T18:26:28+0000"
                    ]
                },
                "id": {
                    "type": "integer",
                    "title": "The address identifier",
                    "examples": [
                        6869356
                    ]
                },
                "neighborhood": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "The address neighborhood of account",
                    "examples": [
                        "Random Estates"
                    ]
                },
                "state": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "The address state of account",
                    "examples": [
                        "SP"
                    ]
                },
                "customer_ids": {
                    "type": [
                        "array",
                        "null"
                    ],
                    "items": {
                        "type": "integer"
                    },
                    "title": "The ids of the customers linked to an account address",
                    "examples": [
                        1,
                        2
                    ]
                },
                "custom_fields": {
                    "type": [
                        "object",
                        "null"
                    ],
                    "title": "Custom fields",
                    "description": "Metadata field with any key-value pairs.",
                    "examples": [
                        {
                            "value_1": 800,
                            "value_2": "17f43184-f1b5-4bac-9fba-49e2d178d1a4"
                        }
                    ]
                }
            }
        }
    }
}