Annotate one field

PATCH

/orgs/{org}/config/fields/{module}/{apiName}

curl --request PATCH \
  --url https://api.sloose.com/orgs/org_9f3c/config/fields/accounts/Account_Name \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "format": "example", "examples": [ "example" ], "aliases": [ "example" ], "pii": true, "derived": true, "defaultMapping": { "mode": "column", "source": "example", "staticValue": "example", "transform": "example", "skip": true, "searchField": "example", "searchMethod": "example", "searchExpression": "example", "patch": { "when": [ "pending" ], "overwrite": "always" } }, "excluded": true }'

• Production
• Staging

Changes a single field’s annotation without sending the module’s whole set.

Authorizations

• sessionAuth
• apiTokenAuth

Parameters

Path Parameters

org

required

The org id the session was issued for. A token for one org can never read another.

string

Example

org_9f3c

The org id the session was issued for. A token for one org can never read another.

module

required

The module’s key or CRM API name — either is accepted.

string

Example

accounts

The module’s key or CRM API name — either is accepted.

apiName

required

The field’s CRM API name.

string

Example

Account_Name

The field’s CRM API name.

Request Body^required

Media typeapplication/json

object

description

string

format

string

examples

Array<string>

aliases

Array<string>

pii

boolean

derived

boolean

defaultMapping

object

mode

string

Allowed values: column static expression search skip

source

string | null

staticValue

string | null

transform

string | null

skip

boolean

searchField

string | null

searchMethod

string | null

searchExpression

string | null

patch

object

when

Array<string>

Allowed values: pending created updated exists skipped filtered guarded dryrun error blocked

overwrite

string

Allowed values: always if-absent

excluded

boolean

Responses

200

The field as it now stands.

Media typeapplication/json

object

field

required

A destination field definition, plus present, removedAt and the org’s annotation.

object

key

additional properties

Example^generated

{
  "field": {
    "additionalProperty": "example"
  }
}

400

The request body did not match the schema. issues carries the Zod issue list.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

401

No bearer, or one that is expired, revoked or no longer resolves to a member.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

The bearer’s role is too low, or it was issued for a different org.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

404

No such module or field, or it is not visible to this session.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}