Field Mappings
Define target Field
POST
/
field_mappings
/
define
Authorizations
x-api-key
string
headerrequiredBody
application/json
object_type_owner
enum<string> | null
requiredAvailable options:
company
, contact
, deal
, lead
, note
, task
, engagement
, stage
, user
name
string | null
requiredThe name of the target field
description
string | null
requiredThe description of the target field
data_type
enum<string> | null
requiredThe data type of the target field
Available options:
string
, number
Response
201 - application/json
id_attribute
string | null
requiredAttribute Id
status
string | null
requiredAttribute Status
ressource_owner_type
string | null
requiredAttribute Ressource Owner Type
slug
string | null
requiredAttribute Slug
description
string | null
requiredAttribute Description
data_type
enum<string> | null
requiredAttribute Data Type
Available options:
string
, number
remote_id
string | null
requiredAttribute Remote Id
source
string | null
requiredAttribute Source
id_entity
string | null
requiredAttribute Entity Id
id_project
string | null
requiredAttribute Project Id
scope
string | null
requiredAttribute Scope
id_consumer
string | null
requiredAttribute Consumer Id
created_at
string | null
requiredAttribute Created Date
modified_at
string | null
requiredAttribute Modified Date
Was this page helpful?