Creates or updates a custom attribute for a customer profile.
Open in API Reference
The ID of the target customer profile.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
''
The key of the custom attribute to create or update. This key must match the key of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.
key
The custom attribute to create or update, with the following fields:
value. This value must conform to the schema specified by the definition. For more information, see Value data types.
value
schema
version. To enable optimistic concurrency control for an update operation, include this optional field and specify the current version of the custom attribute.
version
The identifier of the custom attribute definition and its corresponding custom attributes. This value can be a simple key, which is the key that is provided when the custom attribute definition is created, or a qualified key, if the requesting application is not the definition owner. The qualified key consists of the application ID of the custom attribute definition owner followed by the simple key that was provided when the definition was created. It has the format application_id:simple key.
The value for a simple key can contain up to 60 alphanumeric characters, periods (.), underscores (_), and hyphens (-).
A nonexistent value. In an API request this value will appear as null. Can be used to clear a field entirely.
null
The value assigned to the custom attribute. It is validated against the custom attribute definition's schema on write operations. For more information about custom attribute values, see Custom Attributes Overview.
Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed. When updating an existing custom attribute value, you can provide this field and specify the current version of the custom attribute to enable optimistic concurrency. This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads, see Custom Attributes Overview.
A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.
// No response received yet.