Appearance

Create Contacts ​

Endpoint ​

http
POST /unified/ticketing/contacts
Integrations supported
  • Dixa
  • Enchant
  • Front
  • Gorgias
  • HappyFox
  • Help Scout
  • Productboard
  • Quickbase for Project Management
  • Re:amaze
  • SurveySparrow Ticket Management
  • Zendesk

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

name
string

The name of the contact

Supported in
  • LiveChat
emails
object[]

The emails of the contact

Supported in
  • LiveChat
email
string
REQUIRED · 

The email of the contact

type
string

The type of the email

remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string
REQUIRED · 

The unique identifier for a contact

Supported in
  • Dixa
  • Enchant
  • Front
  • Gorgias
  • Productboard
  • Quickbase for Project Management
  • Re:amaze
  • SurveySparrow Ticket Management
  • Zendesk
first_name
string

The first name of the contact

Supported in
  • Dixa
  • Enchant
  • Gorgias
  • SurveySparrow Ticket Management
last_name
string

The last name of the contact

Supported in
  • Dixa
  • Enchant
  • Gorgias
  • SurveySparrow Ticket Management
name
string

The name of the contact

Supported in
  • Dixa
  • Enchant
  • Front
  • Gorgias
  • Productboard
  • Re:amaze
  • SurveySparrow Ticket Management
  • Zendesk
emails
object[]

The emails of the contact

Supported in
  • Dixa
  • Enchant
  • Front
  • Gorgias
  • Productboard
  • Re:amaze
  • SurveySparrow Ticket Management
  • Zendesk
email
string
REQUIRED · 

The email of the contact

type
string

The type of the email

phones
object[]

The phone numbers of the contact

Supported in
  • Dixa
  • Enchant
  • Gorgias
  • Re:amaze
  • SurveySparrow Ticket Management
  • Zendesk
number
string

The phone of the contact

extension
string

The extension of the phone number

type
string

The type of the phone

details
string

The details of the contact

Supported in
  • Front
  • Gorgias
  • Re:amaze
  • Zendesk
account_id
string

The account id of the contact

Supported in
  • Front
  • Productboard
created_at
string · date-time

The date the contact was created

Supported in
  • Dixa
  • Gorgias
  • Re:amaze
  • SurveySparrow Ticket Management
  • Zendesk
updated_at
string · date-time

The date the contact was last updated

Supported in
  • Front
  • Gorgias
  • Re:amaze
  • Zendesk
etag
string

The unique identifier for the specific version of the resource.

custom_fields
object

All the custom fields present on the contact

Supported in
  • Dixa
  • Front
  • Quickbase for Project Management
  • Re:amaze
is_active
boolean

Whether the contact is active or not

Supported in
  • SurveySparrow Ticket Management
remote_data
object

Raw data returned from the remote API call.