Take one column name back from a field

DELETE

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

curl --request DELETE \
  --url 'https://api.sloose.com/orgs/org_9f3c/config/fields/accounts/Account_Name/aliases?connector=con_8f2a' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "alias": "Cust No" }'

• Production
• Staging

Takes one name out of a field’s aliases — the undo of the route above. Only that name, exactly as sent: the rest of the list and of the field stays as it is, whoever wrote it. A name the field does not have writes nothing and leaves the registry version where it was (removed: false). ?connector= is required.

It is conditional on no version, so an If-Match naming one — or any value but * — is refused with 400 (code: IF_MATCH_NOT_TAKEN) rather than ignored: a client sending one believes the write waits on it. If-Match: *, which asks for nothing, is accepted, as everywhere If-Match is read.

The answer carries no registryVersion, for the same reason as the route above.

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.

Query Parameters

connector

The connection this is about, by id: one of the org’s, or your own. REQUIRED: absent or empty is 400 CONNECTION_REQUIRED, listing the connections this bearer may name, because nothing picks one for a request that does not say (design §14.8). Any other — another org’s, or another person’s — is 404 CONNECTION_NOT_FOUND.

string

Example

con_8f2a

The connection this is about, by id: one of the org’s, or your own. REQUIRED: absent or empty is 400 CONNECTION_REQUIRED, listing the connections this bearer may name, because nothing picks one for a request that does not say (design §14.8). Any other — another org’s, or another person’s — is 404 CONNECTION_NOT_FOUND.

Request Body^required

Media typeapplication/json

object

alias

required

The column name, as a file calls the field. Spaces around it are dropped.

string

>= 1 characters

Example

Cust No

Responses

200

The field’s aliases, without the name.

Media typeapplication/json

object

aliases

required

The field’s aliases as they now stand.

Array<string>

removed

required

Whether this call took the name out; false when the field did not have it.

boolean

Example^generated

{
  "aliases": [
    "example"
  ],
  "removed": true
}

400

The body did not match the schema (issues carries the Zod issue list), an If-Match other than * was sent (code: IF_MATCH_NOT_TAKEN — this write is conditional on no version, and refuses one rather than ignore it), or: The request named no connection (code: CONNECTION_REQUIRED, with connections: the ones this bearer may name). Nothing picks one for a request that does not say (design §14.8).

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, field or connection, 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"
}

409

The field’s aliases kept changing while this was written (code: ALIASES_BUSY): another writer changed them every time it tried. Nothing was written; send it again.

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"
}