Skip to main content
POST
/
orgs
/
{org_id}
/
contacts
/
{contact_id}
/
channels
Add a custom channel to a contact
curl --request POST \
  --url https://api.useinvent.com/orgs/{org_id}/contacts/{contact_id}/channels \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "username": "<string>"
}
'
{
  "id": "<string>",
  "type": "internal",
  "user_id": "<string>",
  "avatar": "<string>",
  "name": "<string>",
  "username": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "country": "<string>",
  "agent": "<string>",
  "ip": "<string>",
  "language": "<string>",
  "platform_data": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "link": "<string>"
}

Path Parameters

​
org_id
string
required

Org ID

​
contact_id
string
required

Contact ID

Body

Schema for adding a custom channel to an existing contact. At least one field must be provided.

​
name
string | null

The name for the contact channel

Maximum string length: 256
​
email
string<email> | null

The email for the contact channel

Maximum string length: 256
​
phone
string | null

The phone number for the contact channel

Maximum string length: 256
​
username
string | null

The username for the contact channel

Maximum string length: 256

Response

200 - application/json

Schema for the contact channel

​
id
string
required
​
type
enum<string>
required

ID of the connection integration

Available options:
internal,
custom,
whatsapp_bot,
messenger_bot,
instagram_dm,
telegram_bot,
gmail,
slack_bot,
twilio,
telnyx,
email,
google_calendar
​
user_id
string
required

The unique identifier for the contact channel, e.g Phone Number or User ID

​
avatar
string | null
required

The avatar for the contact channel, e.g X Avatar URL

​
name
string | null
required

The name for the contact channel, e.g Full Name

​
username
string | null
required

The username for the contact channel, e.g Username

​
email
string | null
required

The email for the contact channel, e.g Email

​
phone
string | null
required

The phone number for the contact channel, e.g Phone Number

​
country
string | null
required

The country code associated with the contact channel, e.g US for United States

​
agent
string | null
required

The user agent associated with the contact channel

​
ip
string | null
required

The IP address associated with the contact channel

​
language
string | null
required

The language code associated with the contact channel, e.g en for English

​
platform_data
object
required

Schema for the platform-specific data of a contact channel

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
link
string

A link to the contact channel, e.g a link to the social media profile