Sign in

v49

latestOpenAPI 3.0.0raw.githubusercontent.com2024-12-22168107389.8 KB
fieldMappings

Create Custom Field

post/field_mappings

Request body

object_type_owner'company' | 'contact' | 'deal' | 'lead' | 'note' | 'task' | 'engagement' | 'stage' | 'user' nullable required
namestring nullable required

The name of the custom field

descriptionstring nullable required

The description of the custom field

data_type'string' | 'number' nullable required

The data type of the custom field

source_custom_field_idstring nullable required

The source custom field ID

source_providerstring nullable required

The name of the source software/provider

linked_user_idstring nullable required

The linked user ID

Example request

{
  "object_type_owner": "company",
  "name": "my_favorite_dish",
  "description": "Favorite Dish",
  "data_type": "string",
  "source_custom_field_id": "id_1",
  "source_provider": "hubspot",
  "linked_user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
}

Response

id_attributestring nullable required

Attribute Id

statusstring nullable required

Attribute Status

ressource_owner_typestring nullable required

Attribute Ressource Owner Type

slugstring nullable required

Attribute Slug

descriptionstring nullable required

Attribute Description

data_type'string' | 'number' nullable required

Attribute Data Type

remote_idstring nullable required

Attribute Remote Id

sourcestring nullable required

Attribute Source

id_entitystring nullable required

Attribute Entity Id

id_projectstring nullable required

Attribute Project Id

scopestring nullable required

Attribute Scope

id_consumerstring nullable required

Attribute Consumer Id

created_atstring date-time nullable required

Attribute Created Date

modified_atstring date-time nullable required

Attribute Modified Date

Example response

{
  "id_attribute": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "slug": "fav_dish",
  "description": "My favorite dish",
  "data_type": "string",
  "remote_id": "id_1",
  "source": "hubspot",
  "id_entity": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "id_project": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "id_consumer": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}