Skip to main content

Create contact

POST 

/:organization_id/contacts

Creates a new contact for an organization

Request

Path Parameters

    organization_id integerrequired

    Organization ID

Bodyrequired

    full_namestringrequired

    Full name of the contact

    emailstring

    Email address of the contact

    descriptionstring

    Additional details about the contact

    contact_phones_attributes object[]

    Phone numbers associated with this contact

  • Array [
  • idinteger

    ID of an existing phone record (only for updates)

    numberstring

    Phone number in E.164 format

    _destroyboolean

    Set to true to delete this phone record (only for updates)

  • ]

Responses

Contact created successfully

Schema
    idintegerrequired

    Unique identifier for the contact

    organization_idintegerrequired

    ID of the organization this contact belongs to

    full_namestringrequired

    Full name of the contact

    emailstringnullable

    Email address of the contact

    descriptionstringnullable

    Additional details about the contact

    contact_phones object[]

    List of phone numbers associated with this contact

  • Array [
  • idintegerrequired

    Unique identifier for the contact phone record

    contact_idintegerrequired

    ID of the associated contact

    organization_idintegerrequired

    ID of the organization this phone number belongs to

    numberstringrequired

    Phone number in E.164 format

    phone_typestringnullable

    Type of phone number (e.g., mobile, home, work)

    created_atdate-time

    Creation timestamp

    updated_atdate-time

    Last update timestamp

  • ]
  • created_atdate-time

    Creation timestamp

    updated_atdate-time

    Last update timestamp

Authorization: http

name: basicAuthtype: httpscheme: basicdescription: Basic authentication using API key ID and API key
import http.client
import json

conn = http.client.HTTPSConnection("cloud-staging.cloverhound.com")
payload = ''
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
}
conn.request("POST", "/:organization_id/contacts", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
Request Collapse all
Auth
Parameters
— pathrequired
Body required
{
  "full_name": "string",
  "email": "string",
  "description": "string",
  "contact_phones_attributes": [
    {
      "id": 0,
      "number": "string",
      "_destroy": true
    }
  ]
}