fieldMappings

Define target Field

Changed on
post/field_mappings/define

Request

  • Base URL
    https://api.panora.dev
  • URL
    https://api.panora.dev/field_mappings/define
  • Auth
    API key in header x-api-key

Request body

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

The name of the target field

descriptionstring nullable required

The description of the target field

data_type'string' | 'number' nullable required

The data type of the target field

Example request

{
  "object_type_owner": "company",
  "name": "fav_dish",
  "description": "My favorite dish",
  "data_type": "string"
}

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

  • ca0fa45ebd05Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • warning

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

    • warning

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

    • info

      added the new company enum value to the request property

    • info

      added the new contact enum value to the request property

    • info

      added the new deal enum value to the request property

    • info

      added the new engagement enum value to the request property

    • info

      added the new lead enum value to the request property

    • info

      added the new note enum value to the request property

    • info

      added the new number enum value to the request property

    • info

      added the new stage enum value to the request property

    • info

      added the new string enum value to the request property

    • info

      added the new task enum value to the request property

    • info

      added the new user enum value to the request property

  • ca213ae36b7fRevision changes
    • info

      endpoint added