PUT
/
customer
/
{id}
/
properties
/
{propertyId}
Update Customer Property
curl --request PUT \
  --url https://chat.zoko.io/v2/customer/{id}/properties/{propertyId} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "type": "text",
  "title": "<string>",
  "description": "<string>",
  "messages": [
    "<string>"
  ],
  "priority": 123
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entityType": "customer",
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "text",
  "title": "<string>",
  "description": "<string>",
  "messages": [
    "<string>"
  ],
  "priority": 123
}

Authorizations

apikey
string
header
required

Authentication is done via apikey provided for your account

Include the following in your request header

apikey: "your_apikey_here"

Path Parameters

id
string<uuid>
required

ID of customer

propertyId
string<uuid>
required

ID of property

Body

application/json

Property data

Customer property model

type
enum<string>

type of property

Available options:
text,
image,
document,
video
title
string
description
string

details on the property

messages
string[]

url(s) for type image, document and video. Text for type text

priority
integer

order in which it should be displayed on the web app

Response

Update Customer Property

Customer property response model

id
string<uuid>
entityType
enum<string>
Available options:
customer
entityId
string<uuid>
type
enum<string>
Available options:
text,
image,
document,
video
title
string
description
string
messages
string[]
priority
integer