/lookup/{table}/{field}/{value}

DELETE /lookup/{table}/{field}/{value}

Delete a lookup value by value

Deletes an existing lookup value for a specific table and field. Only account administrators can delete lookup values.

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

table path string

The table name containing the lookup value

field path string

The field name containing the lookup value

value path string

The value of the lookup option to delete

Try it out

Output:

Responses

Description

Lookup value deleted successfully

{
  "message": "Lookup value deleted successfully"
}

Description

Bad request - invalid table, field, or value

{
  "error": "string",
  "status": 0,
  "message": "string"
}

Description

Not found - lookup value does not exist

{
  "error": "string",
  "status": 0,
  "message": "string"
}

Description

Internal server error

{
  "error": "string",
  "status": 0,
  "message": "string"
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/Error

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/Error

OpenAPI
TypeScript

type: object
properties:
  error:
    type: string
    description: Error message
  status:
    type: integer
    description: HTTP status code
  message:
    type: string
    description: Detailed error message
description: Error response object
required:
  - error

|
export interface Error {
  /** Error message */
  error: string;
  /** HTTP status code */
  status?: number;
  /** Detailed error message */
  message?: string;
}

Route Source Code

Check out the source code for this route entrypoint here: /lookup/[table]/[field]/[value]/route.ts

Or the swagger.yaml spec this documentation was generated from: /lookup/swagger.yaml