Set connector field mapping

• x-corma-api-key

  string

  header

  required

  Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

• id

  string

  path

  required

  The identifier of the connector, as GET /connectors returned it, or the id of its connection. The kind.method form names the only connection of that integration; with several, it answers 409.

• targetFieldId

  string

  path

  required

  The field of the connector, as GET /connectors/{id}/field-mappings returned its identifier.

• 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.

OK

• targetFieldId

  string

  required

  The field of the connector this mapping fills, as GET /connectors/{id}/fields returned its identifier.

• targetLabel

  string

  required

  The name of the field, as Corma displays it.

• 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 the connector documents the field or the workspace defined it.

  One of:

  standard

  custom
• required

  boolean

  required

  True when the connector needs this field to create an account. A required field cannot be switched off.

• note

  string | null

  required

  One sentence about the field, to show beside it. Null when the label is sufficient.

• expression

  string | null

  required

  The expression that computes the value, as it was written. Its variables are rooted on user. Null when Corma writes nothing into the field.

• skipEmpty

  boolean

  required

  When true, an expression that resolves to nothing leaves the field out of the request Corma sends instead of writing an empty value.

• source

  enum<string>

  required

  Where the expression comes from.

  One of:

  default

  custom

  off

  none