/lookup/{table}/{field}/id/{id}

PUT /lookup/{table}/{field}/id/{id}

Update a lookup value by ID

Updates an existing lookup value identified by its ID for a specific table and field. Only account administrators can update 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

id path integer

The ID of the lookup option to update

Request Body

{}

{
  "text": "Updated Text",
  "value": "updated_value"
}

{
  "text": "Updated Full Example Text",
  "value": "updated_full_example_value",
  "parent_id": 2,
  "custom_sort_index": 20,
  "group_name": "Updated Example Group",
  "locale": "es-ES",
  "description": "This is an updated full example of a lookup value",
  "is_active": false,
  "metadata": {
    "additional_info": "Updated extra information"
  },
  "expires_at": "2024-12-31T23:59:59Z"
}

{
  "text": "string",
  "value": "string",
  "parent_id": 0,
  "custom_sort_index": 0,
  "displayOrder": 0,
  "group_name": "string",
  "locale": "string",
  "description": "string",
  "is_active": false,
  "metadata": {},
  "expires_at": "string"
}

Try it out

Output:

Responses

Description

Lookup value updated successfully

{
  "message": "Lookup value updated successfully",
  "lookupValue": {
    "id": 0,
    "text": "string",
    "value": "string",
    "displayOrder": 0,
    "metadata": {},
    "parent_id": 0,
    "custom_sort_index": 0,
    "group_name": "string",
    "locale": "string",
    "description": "string",
    "is_active": false,
    "expires_at": "string"
  }
}

Description

Bad request - invalid input data

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

Description

Not found - lookup value with ID 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/UpdateLookupValue #/components/schemas/LookupOption #/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/UpdateLookupValue

OpenAPI
TypeScript

type: object
description: Input for updating a lookup value
properties:
  text:
    type: string
    description: Display text for the lookup option
  value:
    type: string
    description: Internal value for the lookup option
  parent_id:
    type: integer
    nullable: true
    description: ID of the parent lookup option if this is a child option
  custom_sort_index:
    type: integer
    nullable: true
    description: Custom index for sorting the lookup options
  displayOrder:
    type: integer
    description: Order in which the option should be displayed
  group_name:
    type: string
    nullable: true
    description: Group name for organizing lookup options
  locale:
    type: string
    nullable: true
    description: Locale code for internationalization
  description:
    type: string
    nullable: true
    description: Detailed description of the lookup option
  is_active:
    type: boolean
    description: Whether the lookup option is active
  metadata:
    type: object
    nullable: true
    description: Additional data to store with the lookup option
  expires_at:
    type: string
    format: date-time
    nullable: true
    description: Expiration date and time for the lookup option

|
export interface UpdateLookupValue {
  /** Display text for the lookup option */
  text?: string;
  /** Internal value for the lookup option */
  value?: string;
  /** ID of the parent lookup option if this is a child option */
  parent_id?: number;
  /** Custom index for sorting the lookup options */
  custom_sort_index?: number;
  /** Order in which the option should be displayed */
  displayOrder?: number;
  /** Group name for organizing lookup options */
  group_name?: string;
  /** Locale code for internationalization */
  locale?: string;
  /** Detailed description of the lookup option */
  description?: string;
  /** Whether the lookup option is active */
  is_active?: boolean;
  /** Additional data to store with the lookup option */
  metadata?: {};
  /** Expiration date and time for the lookup option */
  expires_at?: Date;
}

#/components/schemas/LookupOption

OpenAPI
TypeScript

type: object
description: Lookup option for a specific table/field combination
properties:
  id:
    type: integer
    description: Unique identifier for the lookup option
  text:
    type: string
    description: Display text for the lookup option
  value:
    type: string
    description: Internal value of the lookup option
  displayOrder:
    type: integer
    description: Order in which the option should be displayed
  metadata:
    type: object
    description: Additional data associated with the lookup option
  parent_id:
    type: integer
    description: ID of the parent lookup option if this is a child option
  custom_sort_index:
    type: integer
    description: Custom index for sorting the lookup options
  group_name:
    type: string
    description: Group name for organizing lookup options
  locale:
    type: string
    description: Locale code for internationalization
  description:
    type: string
    description: Detailed description of the lookup option
  is_active:
    type: boolean
    description: Whether the lookup option is active
  expires_at:
    type: string
    format: date-time
    description: Expiration date and time for the lookup option
required:
  - id
  - value

|
export interface LookupOption {
  /** Unique identifier for the lookup option */
  id: number;
  /** Display text for the lookup option */
  text?: string;
  /** Internal value of the lookup option */
  value: string;
  /** Order in which the option should be displayed */
  displayOrder?: number;
  /** Additional data associated with the lookup option */
  metadata?: {};
  /** ID of the parent lookup option if this is a child option */
  parent_id?: number;
  /** Custom index for sorting the lookup options */
  custom_sort_index?: number;
  /** Group name for organizing lookup options */
  group_name?: string;
  /** Locale code for internationalization */
  locale?: string;
  /** Detailed description of the lookup option */
  description?: string;
  /** Whether the lookup option is active */
  is_active?: boolean;
  /** Expiration date and time for the lookup option */
  expires_at?: Date;
}

#/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]/id/[id]/route.ts

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