POST
/
backend
/
contact
/
:organization_id
curl --location 'https://api-v2.opencopilot.so/backend/contact/:organization_id' \
  --header 'Authorization: Bearer TOKEN' \ 
  --header 'Content-Type: application/json' 
{
  "copilot_id": "6486fa96-80ac-4654-bf71-f793893e8fef",
  "email": "hello@gmail.com",
  "name": "string",
  "phone_number": "string",
  "custom_data": "{}",
  "created_at": null,
  "updated_at": null,
  "id": "82e95723-245b-47c0-9cf2-2dd3d3914a40"
}

This endpoint is protected by the same JWT that the user uses to call other APIs. The response will include data for the specified chatbot, along with other metadata information.

You can create a new contact in your organization at Open by calling this endpoint, a contact is a user that can interact with the chatbot, phone AI or email AI, a single contact might have multiple conversations across different channels.

organization_id
string
required

The unique identifier for the copilot (organization) you want to create a contact for. This is a required parameter.

copilot_id
string
default: "uuid"required

The unique identifier for the copilot_id (organization_id) you want to create a contact for. This is a required parameter.

email
string
default: "string"

The email address of the contact.

name
string
default: "string"

The name of the contact.

phone_number
string
default: "string"

The phone number of the contact.

custom_data
object
default: "{}"

An object containing any custom data you want to associate with the contact.

curl --location 'https://api-v2.opencopilot.so/backend/contact/:organization_id' \
  --header 'Authorization: Bearer TOKEN' \ 
  --header 'Content-Type: application/json' 
{
  "copilot_id": "6486fa96-80ac-4654-bf71-f793893e8fef",
  "email": "hello@gmail.com",
  "name": "string",
  "phone_number": "string",
  "custom_data": "{}",
  "created_at": null,
  "updated_at": null,
  "id": "82e95723-245b-47c0-9cf2-2dd3d3914a40"
}

You can pass any custom data you want to associate with the contact. This data will be returned in the response and can be used for any purpose you want, just make sure it’s a valid JSON string object.