Corporate account updated
This event occurs when a corporate account is changed.
Type: object
Domain: corporate
Event: corporate_account_change
Version: 1
account_id required
Title: Account ID
Description: Unique ID associated with the Pismo account. This field is used to retrieve the account in the Pismo platform APIs.
Type: integer
Example:
100602614
division_id
Title: Division ID
Description: Unique ID used to identify the division in the Pismo platform APIs.
Type: string
Max length: 36
Example:
1d22e668-a857-4455-aee7-dbe888f4bf2b
division_code
Title: Division Code
Description: Unique code string that uniquely identifies the division within your organization.
Type: string
Max length: 36
Example:
division-code-123
program_id
Title: Program ID
Description: Unique ID used to identify the program in the Pismo platform APIs.
Type: integer
Example:
20
applicant
Type: object
custom_fields
Title: Custom fields
Description: Metadata field with any key-value pairs.
Type: object or null
Example:{ "custom_info": "value" }
external_id
Title: External ID
Description: Custom account ID string that uniquely identifies the account within your organization. This field is a key that links a Pismo account to your account ID.
Type: string or null
Max length: 60
Example:
df8d5b61-3cc0-4ec1-a72d-61860bff8fed
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Corporate account updated",
"description": "This event occurs when a corporate account is changed.",
"required": [
"account_id"
],
"properties": {
"account_id": {
"type": "integer",
"title": "Account ID",
"description": "Unique ID associated with the Pismo account. This field is used to retrieve the account in the Pismo platform APIs.",
"maximum": 2147483647,
"examples": [
100602614
]
},
"division_id": {
"type": "string",
"title": "Division ID",
"description": "Unique ID used to identify the division in the Pismo platform APIs.",
"maxLength": 36,
"examples": [
"1d22e668-a857-4455-aee7-dbe888f4bf2b"
]
},
"division_code": {
"type": "string",
"title": "Division Code",
"description": "Unique code string that uniquely identifies the division within your organization.",
"maxLength": 36,
"examples": [
"division-code-123"
]
},
"program_id": {
"type": "integer",
"title": "Program ID",
"description": "Unique ID used to identify the program in the Pismo platform APIs.",
"maximum": 2147483647,
"examples": [
20
]
},
"applicant": {
"$ref": "#/definitions/applicant"
},
"external_id": {
"type": [
"string",
"null"
],
"title": "External ID",
"description": "Custom account ID string that uniquely identifies the account within your organization. This field is a key that links a Pismo account to your account ID.",
"maxLength": 60,
"examples": [
"df8d5b61-3cc0-4ec1-a72d-61860bff8fed"
]
}
},
"definitions": {
"applicant": {
"type": "object",
"required": [],
"properties": {
"custom_fields": {
"type": [
"object",
"null"
],
"title": "Custom fields",
"description": "Metadata field with any key-value pairs.",
"examples": [
{
"custom_info": "value"
}
]
}
}
}
}
}
{
"account_id": 100602614,
"division_id": "1d22e668-a857-4455-aee7-dbe888f4bf2b",
"division_code": "division-code-123",
"program_id": 20,
"applicant": {
"custom_fields": {
"custom_info": "value"
}
},
"external_id": "df8d5b61-3cc0-4ec1-a72d-61860bff8fed"
}
Updated 6 days ago