Skip to content

Create Contacts

Endpoint

http
POST /unified/ticketing/contacts
Integrations supported
  • Happyfox

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. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
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.
Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

first_name
string
The first name of the contact
Required in
  • Happyfox
last_name
string
The last name of the contact
Supported in
  • Happyfox
name
string
The name of the contact
Supported in
  • Happyfox
emails
object[]
The emails of the contact
Supported in
  • Happyfox
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
  • Happyfox
number
string
The phone of the contact
extension
string
The extension of the phone number
type
string
The type of the phone
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
first_name
string
The first name of the contact
last_name
string
The last name of the contact
name
string
The name of the contact
emails
object[]
The emails of the contact
email
string
REQUIRED · The email of the contact
type
string
The type of the email
phones
object[]
The phone numbers of the contact
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
account_id
string
The account id of the contact
created_at
string · date-time
The date the contact was created
updated_at
string · date-time
The date the contact was last updated
remote_data
object
Raw data returned from the remote API call.