Set user field mapping

Say where one Corma user field takes its value from. A field has one source at a time, so this replaces whatever was configured before rather than adding to it. A configured field cannot return to the connector defaults.

PUT

/v1/user-fields/{id}/mapping

PUT

/user-fields/{id}/mapping

curl -X PUT "https://api.corma.io/v1/user-fields/{id}/mapping" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "source",
  "connectorId": "string",
  "expression": "string"
}'

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
string
path
required
The identifier of the user field, as GET /user-fields returned it.
x-corma-idempotency-key
string
header
Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.

Body

application/json

any of

Response

application/json200

id
string
required
The identifier of the field — jobTitle for a standard field, custom.<key> for one the workspace defined. The manager is one field, manager.
label
string
required
The name of the field, as Corma displays it.
description
string | null
required
One sentence that says what the field holds. Null for a field the workspace defined.
type
enum<string>
required
The type of value the field holds.
One of:
string
number
boolean
date
string[]
object[]
user
origin
enum<string>
required
Whether Corma defines the field or the workspace does.
One of:
standard
custom
inboundMappable
boolean
required
Whether a connector may feed this field. False for the professional email, which matches a person across connectors, and for the fields Corma computes from another one.
defaultSources
string[]
required
The connected connectors that write this field in the default mode. Empty when no connector declares a default for it.
mapping
any of
required
Where the field takes its value from.

{
  "id": "string",
  "label": "string",
  "description": "string",
  "type": "string",
  "origin": "standard",
  "inboundMappable": true,
  "defaultSources": [
    "string"
  ],
  "mapping": {
    "mode": "default"
  }
}

PUT

/user-fields/{id}/mapping

curl -X PUT "https://api.corma.io/v1/user-fields/{id}/mapping" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "source",
  "connectorId": "string",
  "expression": "string"
}'

{
  "id": "string",
  "label": "string",
  "description": "string",
  "type": "string",
  "origin": "standard",
  "inboundMappable": true,
  "defaultSources": [
    "string"
  ],
  "mapping": {
    "mode": "default"
  }
}

- GETList user fields
- PUTSet user field mapping

Set user field mapping - Corma Help Center | Productlane

API referenceUser fields

Set user field mapping

PUT

/v1/user-fields/{id}/mapping

PUT

/user-fields/{id}/mapping

curl -X PUT "https://api.corma.io/v1/user-fields/{id}/mapping" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "source",
  "connectorId": "string",
  "expression": "string"
}'

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
string
path
required
The identifier of the user field, as GET /user-fields returned it.
x-corma-idempotency-key
string
header
Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.

Body

application/json

any of

Response

application/json200

id
string
required
The identifier of the field — jobTitle for a standard field, custom.<key> for one the workspace defined. The manager is one field, manager.
label
string
required
The name of the field, as Corma displays it.
description
string | null
required
One sentence that says what the field holds. Null for a field the workspace defined.
type
enum<string>
required
The type of value the field holds.
One of:
string
number
boolean
date
string[]
object[]
user
origin
enum<string>
required
Whether Corma defines the field or the workspace does.
One of:
standard
custom
inboundMappable
boolean
required
Whether a connector may feed this field. False for the professional email, which matches a person across connectors, and for the fields Corma computes from another one.
defaultSources
string[]
required
The connected connectors that write this field in the default mode. Empty when no connector declares a default for it.
mapping
any of
required
Where the field takes its value from.

{
  "id": "string",
  "label": "string",
  "description": "string",
  "type": "string",
  "origin": "standard",
  "inboundMappable": true,
  "defaultSources": [
    "string"
  ],
  "mapping": {
    "mode": "default"
  }
}

PUT

/user-fields/{id}/mapping

curl -X PUT "https://api.corma.io/v1/user-fields/{id}/mapping" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "source",
  "connectorId": "string",
  "expression": "string"
}'

{
  "id": "string",
  "label": "string",
  "description": "string",
  "type": "string",
  "origin": "standard",
  "inboundMappable": true,
  "defaultSources": [
    "string"
  ],
  "mapping": {
    "mode": "default"
  }
}