Files
sdk/docs/ContactsApi.md
zeekayandHanzo Dev b55332704a feat: Hanzo Cloud SDK for Kotlin (generated from OpenAPI v8.0.0)
Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and
Android. Generated with openapi-generator kotlin (library=jvm-okhttp4,
useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-25 07:10:32 -07:00

6.7 KiB

ContactsApi

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
crmCreateContact POST /v1/crm/contacts Create a contact
crmDeleteContact DELETE /v1/crm/contacts/{id} Delete a contact (clears opportunity point-of-contact refs)
crmGetContact GET /v1/crm/contacts/{id} Contact detail
crmListContacts GET /v1/crm/contacts List contacts
crmUpdateContact PUT /v1/crm/contacts/{id} Update a contact

crmCreateContact

CrmContact crmCreateContact(crmContactInput)

Create a contact

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ContactsApi()
val crmContactInput : CrmContactInput =  // CrmContactInput | 
try {
    val result : CrmContact = apiInstance.crmCreateContact(crmContactInput)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ContactsApi#crmCreateContact")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ContactsApi#crmCreateContact")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
crmContactInput CrmContactInput

Return type

CrmContact

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

crmDeleteContact

crmDeleteContact(id)

Delete a contact (clears opportunity point-of-contact refs)

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ContactsApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    apiInstance.crmDeleteContact(id)
} catch (e: ClientException) {
    println("4xx response calling ContactsApi#crmDeleteContact")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ContactsApi#crmDeleteContact")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String

Return type

null (empty response body)

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

crmGetContact

CrmContact crmGetContact(id)

Contact detail

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ContactsApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : CrmContact = apiInstance.crmGetContact(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ContactsApi#crmGetContact")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ContactsApi#crmGetContact")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String

Return type

CrmContact

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

crmListContacts

CrmListContacts200Response crmListContacts(companyId, limit)

List contacts

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ContactsApi()
val companyId : kotlin.String = companyId_example // kotlin.String | Filter to one company
val limit : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : CrmListContacts200Response = apiInstance.crmListContacts(companyId, limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ContactsApi#crmListContacts")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ContactsApi#crmListContacts")
    e.printStackTrace()
}

Parameters

| companyId | kotlin.String| Filter to one company | [optional] |

Name Type Description Notes
limit kotlin.Int [optional] [default to 200]

Return type

CrmListContacts200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

crmUpdateContact

CrmContact crmUpdateContact(id, crmContactInput)

Update a contact

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ContactsApi()
val id : kotlin.String = id_example // kotlin.String | 
val crmContactInput : CrmContactInput =  // CrmContactInput | 
try {
    val result : CrmContact = apiInstance.crmUpdateContact(id, crmContactInput)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ContactsApi#crmUpdateContact")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ContactsApi#crmUpdateContact")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
crmContactInput CrmContactInput

Return type

CrmContact

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json