Skip to content

Create Field groups

Endpoint

http
POST /unified/crm/field_groups
Integrations supported
  • HubSpot

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 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.

Defaults to unified.

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. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
entity
string

The entity to get the field groups for

All possible enum values:
  • account
  • contact
  • opportunity
Required in
  • HubSpot

Request Body

Refer Writing data using Unified APIs

name
string
REQUIRED · 

The field group's name. Used in other resources to reference the field group.

Required in
  • HubSpot
label
string

The field group's descriptive label

Supported in
  • HubSpot
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 field group's unique identifier

Supported in
  • HubSpot
name
string
REQUIRED · 

The field group's name. Used in other resources to reference the field group.

Supported in
  • HubSpot
label
string

The field group's descriptive label

Supported in
  • HubSpot
description
string

The field group's description

entity_type
string

The entity type the field group belongs to

All possible enum values:
  • contact
  • account
  • opportunity
Supported in
  • HubSpot
status
string

The field group's status

All possible enum values:
  • active
  • inactive
Supported in
  • HubSpot
created_at
string · date-time

The date and time of the field group's creation

updated_at
string · date-time

The date and time of the field group's last update

remote_data
object

Raw data returned from the remote API call.