Conversation Contacts

Upsert Conversation Contact

Upsert contact

post
/v1/conversation/{conversationId}/contact/upsert

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

conversationIdstring* Required

The ID of the conversation

Request Body * Required

Request Body Schema: application/json

namestring

The associated name

descriptionstring

The associated description

metaobject

Meta data information

emailstring

The email address of the contact

phonestring

The phone number of the contact

import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit({

secret: process.env.CHATBOTKIT_API_KEY!

})

const response = await cbk.conversation.contact.upsert(

conversationId,
{
"name":"string",
"description":"string",
"meta":"object",
"email":"string",
"phone":"string"
}
)
{
"id":"string"
}
The contact was created successfully