Customer changed
This event occurs when customer information changes.
Generated by: Update customer information
More information: Customer objects
Type: object
Domain: account
Event: customer_change
Version: 2
customer_id required
Title: Customer ID
Description: Unique ID used to identify the customer in the Pismo platform APIs.
Type: integer
Example:
100602614
old_customer required
Title: Old customer object
Description: Object with old customer information
Type: objectnickname
Title: Old nickname
Description: Old customer nickname.
Type: string or null
Max length: 128printed_name
Title: Old printed name
Description: Old customer name printed on a card. Ifprinted_name
is not specified, the platform uses thesocial_name
orname
to create theprinted_name
.
Type: string or null
Max length: 25
Example:
Maria M Silva
social_name
Title: Old social name
Description: Old customer social name.
Type: string or null
Max length: 64
Example:
Maria
Title: Old email address
Description: Old customer email address.
Type: string or null
Max length: 255
Example:
[email protected]
is_active
Title: Old active flag
Description: Old flag that indicates whether the customer is active.
Type: boolean
Example:
false
true
new_customer required
Title: New customer object
Description: Object with new customer information
Type: objectnickname
Title: New nickname
Description: New customer nickname.
Type: string or null
Max length: 128printed_name
Title: New printed name
Description: New customer name printed on a card. Ifprinted_name
is not provided, the platform uses thesocial_name
orname
to create theprinted_name
.
Type: string or null
Max length: 25
Example:
Maria M Silva
social_name
Title: New social name
Description: New customer social name.
Type: string or null
Max length: 64
Example:
Maria
Title: New email address
Description: New customer email address.
Type: string or null
Max length: 255
Example:
[email protected]
is_active
Title: New active flag
Description: New flag that indicates whether the customer is active.
Type: boolean
Example:
false
true
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"title": "Customer changed",
"description": "This event occurs when customer information changes. \n Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/customerv2put' target='_blank'>Update customer information</a> \n More information: <a href='https://developers.pismo.io/pismo-docs/docs/working-with-customer-objects' target='_blank'>Customer objects</a>",
"required": [
"customer_id",
"old_customer",
"new_customer"
],
"properties": {
"customer_id": {
"type": "integer",
"title": "Customer ID",
"description": "Unique ID used to identify the customer in the Pismo platform APIs.",
"examples": [
100602614
]
},
"old_customer": {
"type": "object",
"title": "Old customer object",
"description": "Object with old customer information",
"properties": {
"nickname": {
"type": [
"string",
"null"
],
"title": "Old nickname",
"description": "Old customer nickname.",
"maxLength": 128
},
"printed_name": {
"type": [
"string",
"null"
],
"title": "Old printed name",
"description": "Old customer name printed on a card. If `printed_name` is not specified, the platform uses the `social_name` or `name` to create the `printed_name`.",
"maxLength": 25,
"examples": [
"Maria M Silva"
]
},
"social_name": {
"type": [
"string",
"null"
],
"title": "Old social name",
"description": "Old customer social name.",
"maxLength": 64,
"examples": [
"Maria"
]
},
"email": {
"type": [
"string",
"null"
],
"title": "Old email address",
"description": "Old customer email address.",
"maxLength": 255,
"examples": [
"[email protected]"
]
},
"is_active": {
"type": "boolean",
"title": "Old active flag",
"description": "Old flag that indicates whether the customer is active.",
"examples": [
false,
true
]
}
}
},
"new_customer": {
"type": "object",
"title": "New customer object",
"description": "Object with new customer information",
"properties": {
"nickname": {
"type": [
"string",
"null"
],
"title": "New nickname",
"description": "New customer nickname.",
"maxLength": 128
},
"printed_name": {
"type": [
"string",
"null"
],
"title": "New printed name",
"description": "New customer name printed on a card. If `printed_name` is not provided, the platform uses the `social_name` or `name` to create the `printed_name`.",
"maxLength": 25,
"examples": [
"Maria M Silva"
]
},
"social_name": {
"type": [
"string",
"null"
],
"title": "New social name",
"description": "New customer social name.",
"maxLength": 64,
"examples": [
"Maria"
]
},
"email": {
"type": [
"string",
"null"
],
"title": "New email address",
"description": "New customer email address.",
"maxLength": 255,
"examples": [
"[email protected]"
]
},
"is_active": {
"type": "boolean",
"title": "New active flag",
"description": "New flag that indicates whether the customer is active.",
"examples": [
false,
true
]
}
}
}
}
}
Updated 22 days ago