Address created
This event occurs when a new address is created.
Generated by: Create address
More information: Address and phone objects
Type: object
Domain: audit
Event: address_creation
Version: 1
method required
Title: The HTTP Method of address register operation
Type: string
Example:
POST
uri required
Title: The URI of address register operation
Type: string
Example:
/v1/accounts/{accountId}/addresses
email required
Title: The email of operator that registered address
Type: string
Example:
[email protected]
roles required
Type: array
origin required
Title: The request origin of address register operation
Type: string
Example:
APP
CRM
object required
Title: The object that represents the address register requested
Type: objectzip_code required
Title: The address zip code of account
Type: string
Example:
00000-000country required
Title: The address country of account
Type: string
Example:
Braziladdress required
Title: The address of account
Type: string
Example:
Some St.city required
Title: The address city of account
Type: string
Example:
São Pauloaddress_type required
Title: The address type of account
Type: string
Example:
RESIDENTIALactive required
Title: Indicates if account address is active
Type: boolean
Example:
false
truecreation_date required
Title: The address creation date
Type: string
Example:
2019-10-18T18:26:28+0000org_id
Title: The organization identifier of account
Type: string
Example:
TN-9dd08b9e-38fd-4359-949f-b33c3ea0d950number required
Title: The address number of account
Type: integer
Example:
456account_id
Title: The account identifier of address
Type: integer
Example:
32422complementary_address required
Title: The complementary address of account
Type: string or null
Example:
Apto. 11mailing_address required
Title: The mailing address of account
Type: boolean
Example:
false
truelast_update required
Title: The last update of account address
Type: null
Example:
2019-10-18T18:26:28+0000id
Title: The address identifier
Type: integer
Example:
6869356neighborhood required
Title: The address neighborhood of account
Type: string
Example:
Random Estatesstate required
Title: The address state of account
Type: string
Example:
SPcustomer_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 created",
"description": "This event occurs when a new address is created. \n Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/post-accounts-v1-accounts-accountid-addresses' target='_blank'>Create 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 register operation",
"examples": [
"POST"
]
},
"uri": {
"type": "string",
"title": "The URI of address register operation",
"examples": [
"/v1/accounts/{accountId}/addresses"
]
},
"email": {
"type": "string",
"title": "The email of operator that registered address",
"examples": [
"[email protected]"
]
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"title": "The roles of operator that registered address",
"examples": [
"test1",
"test2"
]
},
"origin": {
"type": "string",
"title": "The request origin of address register operation",
"examples": [
"APP",
"CRM"
]
},
"object": {
"type": "object",
"title": "The object that represents the address register requested",
"required": [
"zip_code",
"country",
"address",
"city",
"address_type",
"active",
"creation_date",
"number",
"complementary_address",
"mailing_address",
"last_update",
"neighborhood",
"state"
],
"properties": {
"zip_code": {
"type": "string",
"title": "The address zip code of account",
"examples": [
"00000-000"
]
},
"country": {
"type": "string",
"title": "The address country of account",
"examples": [
"Brazil"
]
},
"address": {
"type": "string",
"title": "The address of account",
"examples": [
"Some St."
]
},
"city": {
"type": "string",
"title": "The address city of account",
"examples": [
"S\u00e3o Paulo"
]
},
"address_type": {
"type": "string",
"title": "The address type of account",
"examples": [
"RESIDENTIAL"
]
},
"active": {
"type": "boolean",
"title": "Indicates if account address is active",
"examples": [
false,
true
]
},
"creation_date": {
"type": "string",
"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",
"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": "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",
"title": "The address neighborhood of account",
"examples": [
"Random Estates"
]
},
"state": {
"type": "string",
"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"
}
]
}
}
}
}
}
Updated 2 days ago