customer custom_attribute_definition visible updated

EVENT

customer.custom_attribute_definition.visible.updated

Published when a customer custom attribute definition that is visible to the subscribing application is updated. A custom attribute definition can only be updated by the application that created it. A notification is sent when your application updates a custom attribute definition or when another application updates a custom attribute definition whose visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.

Permissions:CUSTOMERS_READ

Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of the seller associated with the event that triggered the event notification.

Link to section

type

string

The type of this event. The value is "customer.custom_attribute_definition.visible.updated".

Link to section

event_id

string

A unique ID for the event notification.

Link to section

created_at

string

Read only The timestamp that indicates when the event notification was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

data

The data associated with the event that triggered the event notification.

Show attributes

Link to section

Examples

Response JSON

{
  "merchant_id": "DM7VKY8Q63GNP",
  "type": "customer.custom_attribute_definition.visible.updated",
  "event_id": "ae376c21-d360-4694-96c7-1b27830f07d7",
  "created_at": "2022-04-26T01:22:29Z",
  "data": {
    "type": "custom_attribute_definition",
    "id": "sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size",
    "object": {
      "created_at": "2022-04-21T21:57:39Z",
      "description": "The customer's t-shirt size",
      "key": "sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size",
      "name": "T-Shirt Size",
      "schema": {
        "type": "array",
        "items": {
          "names": [
            "Small",
            "Medium",
            "Large",
            "Extra Large",
            "Extra Small"
          ],
          "enum": [
            "9492bdda-ab4d-4eeb-8496-0986c8f78499",
            "6b96fba7-d8a5-ae72-48f4-8c3ee875633f",
            "4032c1a2-d749-4c75-9c30-be6472cd2e08",
            "89ca2c01-e4e3-43d6-b846-1495c4e8f97b",
            "4f985a76-08fc-44b1-9ec4-b1904685c3a5"
          ]
        },
        "maxItems": 1,
        "uniqueItems": true
      },
      "updated_at": "2022-04-26T01:22:29Z",
      "version": 2,
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    }
  }
}