POST
/
unified
/
crm
/
metadata
/
objects
/
{object_name}
/
properties
curl --request POST \
  --url https://api.openint.dev/v0/unified/crm/metadata/objects/{object_name}/properties \
  --header 'Content-Type: application/json' \
  --header 'x-apikey: <api-key>' \
  --header 'x-connection-id: <api-key>' \
  --data '{
  "id": "FirstName",
  "label": "First Name",
  "type": "string",
  "raw_details": {}
}'
{
  "id": "FirstName",
  "label": "First Name",
  "type": "string",
  "raw_details": {}
}

Authorizations

​
x-apikey
string
header
required
​
x-connection-id
string
header
required

Path Parameters

​
object_name
string
required

Body

application/json
​
id
string
required

The machine name of the property as it appears in the third-party Provider

Example:

"FirstName"

​
label
string
required

The human-readable name of the property as provided by the third-party Provider.

Example:

"First Name"

​
type
string

The type of the property as provided by the third-party Provider. These types are not unified by OpenInt. For Intercom, this is string, integer, boolean, or object. For Outreach, this is integer, boolean, number, array, or string.

Example:

"string"

​
raw_details
object

The raw details of the property as provided by the third-party Provider, if available.

Example:
{}

Response

200
application/json
Successful response
​
id
string
required

The machine name of the property as it appears in the third-party Provider

Example:

"FirstName"

​
label
string
required

The human-readable name of the property as provided by the third-party Provider.

Example:

"First Name"

​
type
string

The type of the property as provided by the third-party Provider. These types are not unified by OpenInt. For Intercom, this is string, integer, boolean, or object. For Outreach, this is integer, boolean, number, array, or string.

Example:

"string"

​
raw_details
object

The raw details of the property as provided by the third-party Provider, if available.

Example:
{}
Previous
Metadata create association
Next