PUT
/
projects
/
{projectIdOrName}
/
providers
/
{provider}
/
object-metadata
curl --request PUT \
--url https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/object-metadata \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"fields": {
"Account": [
{
"fieldName": "Industry",
"displayName": "Industry Sector",
"description": "The industry this account operates in",
"valueType": "string",
"required": false,
"stringOptions": {
"length": 255,
"defaultValue": "Technology"
}
},
{
"fieldName": "Company_Size",
"displayName": "Company Size",
"valueType": "string",
"stringOptions": {
"values": [
"Small",
"Medium",
"Large",
"Enterprise"
],
"valuesRestricted": true
}
}
],
"Contact": [
{
"fieldName": "Seniority_Level",
"displayName": "Seniority Level",
"valueType": "string",
"stringOptions": {
"values": [
"Junior",
"Mid",
"Senior",
"Executive"
],
"valuesRestricted": true
}
}
]
}
}'
{
  "success": true,
  "fields": {}
}

Authorizations

X-Api-Key
string
header
required

Path Parameters

projectIdOrName
string
required

The Ampersand project ID or project name.

provider
string
required

The provider that this connection connects to.

Query Parameters

groupRef
string
required

The ID that your app uses to identify the group of users for this Connection.

Body

application/json

Metadata upsert request containing field definitions to create or update

Request payload for upserting metadata (fields only)

Response

200
application/json

Metadata creation completed successfully

Response containing results for all created/updated fields