POST
/
field_mappings
/
define

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
data_type
enum<string> | null
required

The data type of the target field

Available options:
string,
number
​
description
string | null
required

The description of the target field

​
name
string | null
required

The name of the target field

​
object_type_owner
enum<string> | null
required
Available options:
company,
contact,
deal,
lead,
note,
task,
engagement,
stage,
user

Response

201 - application/json
​
created_at
string | null
required

Attribute Created Date

​
data_type
enum<string> | null
required

Attribute Data Type

Available options:
string,
number
​
description
string | null
required

Attribute Description

​
id_attribute
string | null
required

Attribute Id

​
id_consumer
string | null
required

Attribute Consumer Id

​
id_entity
string | null
required

Attribute Entity Id

​
id_project
string | null
required

Attribute Project Id

​
modified_at
string | null
required

Attribute Modified Date

​
remote_id
string | null
required

Attribute Remote Id

​
ressource_owner_type
string | null
required

Attribute Ressource Owner Type

​
scope
string | null
required

Attribute Scope

​
slug
string | null
required

Attribute Slug

​
source
string | null
required

Attribute Source

​
status
string | null
required

Attribute Status

Was this page helpful?

Suggest editsRaise issue
Create Custom FieldMap Custom Field