Sign in
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"
}

Changes

Changed in 5 of the 18 revisions of this API.3221

  • ca0fa45ebd052211See the full diff
    • ▲

      request property data_type was restricted to a list of enum values

      request-property-became-enum

    • ▲

      request property object_type_owner was restricted to a list of enum values

      request-property-became-enum

    • ●

      added the new number enum value to the data_type response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new string enum value to the data_type response property for the response status 201

      response-property-enum-value-added

    • ○

      added the new company enum value to the request property object_type_owner

      request-property-enum-value-added

    • ○

      added the new contact enum value to the request property object_type_owner

      request-property-enum-value-added

    • ○

      added the new deal enum value to the request property object_type_owner

      request-property-enum-value-added

    • ○

      added the new engagement enum value to the request property object_type_owner

      request-property-enum-value-added

    • ○

      added the new lead enum value to the request property object_type_owner

      request-property-enum-value-added

    • ○

      added the new note enum value to the request property object_type_owner

      request-property-enum-value-added

    • ○

      added the new number enum value to the request property data_type

      request-property-enum-value-added

    • ○

      added the new stage enum value to the request property object_type_owner

      request-property-enum-value-added

    • ○

      added the new string enum value to the request property data_type

      request-property-enum-value-added

    • ○

      added the new task enum value to the request property object_type_owner

      request-property-enum-value-added

    • ○

      added the new user enum value to the request property object_type_owner

      request-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ca213ae36b7f1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 167edd5346ec1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9d25bd589fe98See the full diff
    • ○

      the request property data_type became nullable

      request-property-became-nullable

    • ○

      the request property description became nullable

      request-property-became-nullable

    • ○

      the request property linked_user_id became nullable

      request-property-became-nullable

    • ○

      the request property name became nullable

      request-property-became-nullable

    • ○

      the request property object_type_owner became nullable

      request-property-became-nullable

    • ○

      the request property source_custom_field_id became nullable

      request-property-became-nullable

    • ○

      the request property source_provider became nullable

      request-property-became-nullable

    • ○

      added the media type application/json for the response with the status 201

      response-media-type-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f48b82299d9d1See the full diff
    • ○

      endpoint added

      endpoint-added