Skip to content
Kalipto Devs Platform — API Docs

Patch Contact

PATCH
/platform/v1/contacts/{contact_id}
 
curl --request PATCH \
  --url https://example.com/platform/v1/contacts/1 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: example' \
  --data '{ "contact_metadata": {}, "display_name": "example" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
contact_id
required
Contact Id
integer

Header Parameters

Section titled “Header Parameters ”
X-API-Key
required
X-Api-Key
string

Request Body required

Section titled “Request Body required ”
Media type application/json
PlatformContactPatch
object
contact_metadata
Any of:
object
key
additional properties
any
display_name
Any of:
string
<= 255 characters
Example generated
{
  "contact_metadata": {},
  "display_name": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
PlatformContactResponse
object
business_scoped_user_id
Any of:
string
contact_metadata
Contact Metadata
object
key
additional properties
any
created_at
required
Created At
string format: date-time
display_name
Any of:
string
first_seen_at
required
First Seen At
string format: date-time
id
required
Id
integer
ig_id
Any of:
string
last_seen_at
required
Last Seen At
string format: date-time
phone
Any of:
string
platform_channel_id
required
Platform Channel Id
integer
profile_name
Any of:
string
username
Any of:
string
wa_id
Any of:
string
Example 
{
  "contact_metadata": {}
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}