POST
/
customer
/
{id}
/
properties
Create Customer Property
curl --request POST \
  --url https://chat.zoko.io/v2/customer/{id}/properties \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "type": "text",
  "title": "<string>",
  "description": "<string>",
  "messages": [
    "<string>"
  ],
  "priority": 123
}'
{
  "status": "204",
  "message": "items(s) deleted",
  "details": "deleted items count - xx"
}

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

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

Create Customer Property

Simple generic response for delete

status
string
Example:

"204"

message
string
Example:

"items(s) deleted"

details
string
Example:

"deleted items count - xx"