Skip to main content
POST
/
api
/
public
/
customer
/
upsert
/
info
curl --request POST \
  --url https://api.vambe.me/api/public/customer/upsert/info \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "channel": "whatsapp"
}
'

Headers

​
x-api-key
string
required

API key needed to authorize the request

Body

application/json
​
channel
enum<string>
required

Channel type for the contact.

Available options:
whatsapp,
web-whatsapp,
webchat
​
channel_phone_number
string

Phone number or ID of the channel. Required for whatsapp/web-whatsapp.

Minimum string length: 1
​
channel_id
string<uuid>

UUID of the webchat channel. Required for webchat.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
stageId
string<uuid>

Stage ID to assign to the contact.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
agentId
string<uuid>

Agent ID to assign to the contact.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
contact_phone_number
string

Phone number of the contact. Required for whatsapp/web-whatsapp.

​
external_user_id
string

External user identifier used to find or create the webchat contact. Required for webchat.

Minimum string length: 1
​
contact_email
string

Email of the contact.

​
contact_name
string

Display name of the contact.

​
meta_data
object

Arbitrary metadata to set on the contact.

​
custom_field_values
object[]

Custom field values to upsert on the customer, identified by definition key.

Response

Contact created or found successfully.