POST
/
field_mappings

Authorizations

x-api-key
string
headerrequired

Body

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

The name of the custom field

description
string | null
required

The description of the custom field

data_type
enum<string> | null
required

The data type of the custom field

Available options:
string,
number
source_custom_field_id
string | null
required

The source custom field ID

source_provider
string | null
required

The name of the source software/provider

linked_user_id
string | null
required

The linked user ID

Response

201 - application/json
id_attribute
string | null
required

Attribute Id

status
string | null
required

Attribute Status

ressource_owner_type
string | null
required

Attribute Ressource Owner Type

slug
string | null
required

Attribute Slug

description
string | null
required

Attribute Description

data_type
enum<string> | null
required

Attribute Data Type

Available options:
string,
number
remote_id
string | null
required

Attribute Remote Id

source
string | null
required

Attribute Source

id_entity
string | null
required

Attribute Entity Id

id_project
string | null
required

Attribute Project Id

scope
string | null
required

Attribute Scope

id_consumer
string | null
required

Attribute Consumer Id

created_at
string | null
required

Attribute Created Date

modified_at
string | null
required

Attribute Modified Date

Was this page helpful?

Update webhook statusDefine target Field