> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getruba.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Change Custom Field
> ### Intent
Applies the supplied changes to the custom field.
### When to call it
Call this when the custom field already exists and its stored values need to change.
### Access boundary
Authorize the request with a token that carries `custom_fields:write`.
### Successful result
A successful request returns `200`. The response schema below defines the body your integration receives.
export const RubaSocials = () => {
if (typeof document === "undefined") {
return null;
}
const inject = () => {
const footer = document.getElementById("footer");
if (!footer || document.getElementById("ruba-socials")) {
return false;
}
const isDark = document.querySelector("html.dark") || document.querySelector('html[class*="dark"]');
const lineColor = isDark ? "#383838" : "#e8e8ed";
const iconColor = isDark ? "#8e8e93" : "#86868b";
const markColor = isDark ? "#ffffff" : "#08080c";
const hoverColor = "#0071e3";
const div = document.createElement("div");
div.id = "ruba-socials";
div.style.cssText = `display:flex;align-items:center;gap:20px;padding-top:20px;margin-top:20px;border-top:1px solid ${lineColor};width:100%`;
const logo = `Ruba`;
const spacer = ``;
const ig = ``;
const li = ``;
const x = ``;
const github = ``;
div.innerHTML = logo + spacer + ig + li + x + github;
footer.appendChild(div);
return true;
};
if (!document.documentElement.dataset.rubaSocialsObserver) {
document.documentElement.dataset.rubaSocialsObserver = "true";
const observer = new MutationObserver(() => {
if (!document.getElementById("ruba-socials")) {
inject();
}
});
observer.observe(document.body, {
childList: true,
subtree: true
});
}
setTimeout(() => {
if (!inject()) {
const interval = setInterval(() => {
if (inject()) {
clearInterval(interval);
}
}, 500);
setTimeout(() => clearInterval(interval), 10000);
}
}, 300);
return null;
};
## OpenAPI
````yaml patch /v1/custom-fields/{id}
openapi: 3.1.0
info:
title: Ruba API
summary: Ruba HTTP and Webhooks API
description: '**Details:** Read the docs at https://docs.getruba.com/api-reference.'
version: 2026-04
servers:
- url: https://api.getruba.com
description: '**Details:** Production environment.'
x-speakeasy-server-id: production
- url: https://sandbox-api.getruba.com
description: '**Details:** Sandbox environment.'
x-speakeasy-server-id: sandbox
security: []
tags:
- name: public
description: >-
**Details:** Endpoints shown and documented in the Ruba API documentation
and available in our SDKs.
- name: private
description: >-
**Details:** Endpoints that should appear in the schema only in
development to generate our internal JS SDK.
paths:
/v1/custom-fields/{id}:
patch:
tags:
- custom-fields
- public
summary: Change Custom Field
description: >-
### Intent
Applies the supplied changes to the custom field.
### When to call it
Call this when the custom field already exists and its stored values
need to change.
### Access boundary
Authorize the request with a token that carries `custom_fields:write`.
### Successful result
A successful request returns `200`. The response schema below defines
the body your integration receives.
operationId: custom-fields:update
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid4
description: Identifier of the custom field.
title: Id
description: Identifier of the custom field.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldUpdate'
responses:
'200':
description: '**Response:** Custom field updated.'
content:
application/json:
schema:
$ref: '#/components/schemas/CustomField'
title: CustomField
'404':
description: '**Response:** Custom field could not be found.'
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFound'
'422':
description: Request validation failed
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- oidc:
- custom_fields:write
- pat:
- custom_fields:write
- oat:
- custom_fields:write
components:
schemas:
CustomFieldUpdate:
oneOf:
- $ref: '#/components/schemas/CustomFieldUpdateText'
- $ref: '#/components/schemas/CustomFieldUpdateNumber'
- $ref: '#/components/schemas/CustomFieldUpdateDate'
- $ref: '#/components/schemas/CustomFieldUpdateCheckbox'
- $ref: '#/components/schemas/CustomFieldUpdateSelect'
discriminator:
propertyName: type
mapping:
checkbox:
$ref: '#/components/schemas/CustomFieldUpdateCheckbox'
date:
$ref: '#/components/schemas/CustomFieldUpdateDate'
number:
$ref: '#/components/schemas/CustomFieldUpdateNumber'
select:
$ref: '#/components/schemas/CustomFieldUpdateSelect'
text:
$ref: '#/components/schemas/CustomFieldUpdateText'
CustomField:
oneOf:
- $ref: '#/components/schemas/CustomFieldText'
- $ref: '#/components/schemas/CustomFieldNumber'
- $ref: '#/components/schemas/CustomFieldDate'
- $ref: '#/components/schemas/CustomFieldCheckbox'
- $ref: '#/components/schemas/CustomFieldSelect'
discriminator:
propertyName: type
mapping:
checkbox:
$ref: '#/components/schemas/CustomFieldCheckbox'
date:
$ref: '#/components/schemas/CustomFieldDate'
number:
$ref: '#/components/schemas/CustomFieldNumber'
select:
$ref: '#/components/schemas/CustomFieldSelect'
text:
$ref: '#/components/schemas/CustomFieldText'
ResourceNotFound:
properties:
error:
type: string
const: ResourceNotFound
title: Error
examples:
- ResourceNotFound
detail:
type: string
title: Detail
type: object
required:
- error
- detail
title: ResourceNotFound
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
CustomFieldUpdateText:
properties:
metadata:
additionalProperties:
anyOf:
- type: string
maxLength: 500
minLength: 1
- type: integer
- type: number
- type: boolean
propertyNames:
maxLength: 40
minLength: 1
type: object
maxProperties: 50
title: Metadata
description: |-
Metadata map for information your integration needs to retain.
The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A floating-point number
* A boolean
You can store up to **50 key-value pairs**.
name:
anyOf:
- type: string
minLength: 1
description: Display name assigned to the custom field.
- type: 'null'
title: Name
slug:
anyOf:
- type: string
minLength: 1
pattern: ^[a-z0-9-_]+$
description: >-
**Slug:** Unique organization-wide storage key for this custom
field. Use only ASCII letters, numbers, and hyphens.
- type: 'null'
title: Slug
type:
type: string
const: text
title: Type
properties:
anyOf:
- $ref: '#/components/schemas/CustomFieldTextProperties'
- type: 'null'
type: object
required:
- type
title: CustomFieldUpdateText
description: Schema used to update a custom field of type text.
CustomFieldUpdateNumber:
properties:
metadata:
additionalProperties:
anyOf:
- type: string
maxLength: 500
minLength: 1
- type: integer
- type: number
- type: boolean
propertyNames:
maxLength: 40
minLength: 1
type: object
maxProperties: 50
title: Metadata
description: |-
Metadata map for information your integration needs to retain.
The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A floating-point number
* A boolean
You can store up to **50 key-value pairs**.
name:
anyOf:
- type: string
minLength: 1
description: Display name assigned to the custom field.
- type: 'null'
title: Name
slug:
anyOf:
- type: string
minLength: 1
pattern: ^[a-z0-9-_]+$
description: >-
**Slug:** Unique organization-wide storage key for this custom
field. Use only ASCII letters, numbers, and hyphens.
- type: 'null'
title: Slug
type:
type: string
const: number
title: Type
properties:
anyOf:
- $ref: '#/components/schemas/CustomFieldNumberProperties'
- type: 'null'
type: object
required:
- type
title: CustomFieldUpdateNumber
description: Schema used to update a custom field of type number.
CustomFieldUpdateDate:
properties:
metadata:
additionalProperties:
anyOf:
- type: string
maxLength: 500
minLength: 1
- type: integer
- type: number
- type: boolean
propertyNames:
maxLength: 40
minLength: 1
type: object
maxProperties: 50
title: Metadata
description: |-
Metadata map for information your integration needs to retain.
The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A floating-point number
* A boolean
You can store up to **50 key-value pairs**.
name:
anyOf:
- type: string
minLength: 1
description: Display name assigned to the custom field.
- type: 'null'
title: Name
slug:
anyOf:
- type: string
minLength: 1
pattern: ^[a-z0-9-_]+$
description: >-
**Slug:** Unique organization-wide storage key for this custom
field. Use only ASCII letters, numbers, and hyphens.
- type: 'null'
title: Slug
type:
type: string
const: date
title: Type
properties:
anyOf:
- $ref: '#/components/schemas/CustomFieldDateProperties'
- type: 'null'
type: object
required:
- type
title: CustomFieldUpdateDate
description: Schema used to update a custom field of type date.
CustomFieldUpdateCheckbox:
properties:
metadata:
additionalProperties:
anyOf:
- type: string
maxLength: 500
minLength: 1
- type: integer
- type: number
- type: boolean
propertyNames:
maxLength: 40
minLength: 1
type: object
maxProperties: 50
title: Metadata
description: |-
Metadata map for information your integration needs to retain.
The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A floating-point number
* A boolean
You can store up to **50 key-value pairs**.
name:
anyOf:
- type: string
minLength: 1
description: Display name assigned to the custom field.
- type: 'null'
title: Name
slug:
anyOf:
- type: string
minLength: 1
pattern: ^[a-z0-9-_]+$
description: >-
**Slug:** Unique organization-wide storage key for this custom
field. Use only ASCII letters, numbers, and hyphens.
- type: 'null'
title: Slug
type:
type: string
const: checkbox
title: Type
properties:
anyOf:
- $ref: '#/components/schemas/CustomFieldCheckboxProperties'
- type: 'null'
type: object
required:
- type
title: CustomFieldUpdateCheckbox
description: Schema used to update a custom field of type checkbox.
CustomFieldUpdateSelect:
properties:
metadata:
additionalProperties:
anyOf:
- type: string
maxLength: 500
minLength: 1
- type: integer
- type: number
- type: boolean
propertyNames:
maxLength: 40
minLength: 1
type: object
maxProperties: 50
title: Metadata
description: |-
Metadata map for information your integration needs to retain.
The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A floating-point number
* A boolean
You can store up to **50 key-value pairs**.
name:
anyOf:
- type: string
minLength: 1
description: Display name assigned to the custom field.
- type: 'null'
title: Name
slug:
anyOf:
- type: string
minLength: 1
pattern: ^[a-z0-9-_]+$
description: >-
**Slug:** Unique organization-wide storage key for this custom
field. Use only ASCII letters, numbers, and hyphens.
- type: 'null'
title: Slug
type:
type: string
const: select
title: Type
properties:
anyOf:
- $ref: '#/components/schemas/CustomFieldSelectProperties'
- type: 'null'
type: object
required:
- type
title: CustomFieldUpdateSelect
description: Schema used to update a custom field of type select.
CustomFieldText:
properties:
created_at:
type: string
format: date-time
title: Created At
description: The time Ruba created this record.
modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Modified At
description: The time this record last changed.
id:
type: string
format: uuid4
title: Id
description: The stable identifier for this record.
metadata:
$ref: '#/components/schemas/MetadataOutputType'
type:
type: string
const: text
title: Type
slug:
type: string
title: Slug
description: '**Slug:** Storage key used for this custom field.'
name:
type: string
title: Name
description: Display name assigned to the custom field.
organization_id:
type: string
format: uuid4
title: Organization Id
description: Unique identifier for the organization owning the custom field.
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
x-ruba-selector-widget:
displayProperty: name
resourceName: Organization
resourceRoot: /v1/organizations
properties:
$ref: '#/components/schemas/CustomFieldTextProperties'
type: object
required:
- created_at
- modified_at
- id
- metadata
- type
- slug
- name
- organization_id
- properties
title: CustomFieldText
description: Schema for a custom field of type text.
CustomFieldNumber:
properties:
created_at:
type: string
format: date-time
title: Created At
description: The time Ruba created this record.
modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Modified At
description: The time this record last changed.
id:
type: string
format: uuid4
title: Id
description: The stable identifier for this record.
metadata:
$ref: '#/components/schemas/MetadataOutputType'
type:
type: string
const: number
title: Type
slug:
type: string
title: Slug
description: '**Slug:** Storage key used for this custom field.'
name:
type: string
title: Name
description: Display name assigned to the custom field.
organization_id:
type: string
format: uuid4
title: Organization Id
description: Unique identifier for the organization owning the custom field.
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
x-ruba-selector-widget:
displayProperty: name
resourceName: Organization
resourceRoot: /v1/organizations
properties:
$ref: '#/components/schemas/CustomFieldNumberProperties'
type: object
required:
- created_at
- modified_at
- id
- metadata
- type
- slug
- name
- organization_id
- properties
title: CustomFieldNumber
description: Schema for a custom field of type number.
CustomFieldDate:
properties:
created_at:
type: string
format: date-time
title: Created At
description: The time Ruba created this record.
modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Modified At
description: The time this record last changed.
id:
type: string
format: uuid4
title: Id
description: The stable identifier for this record.
metadata:
$ref: '#/components/schemas/MetadataOutputType'
type:
type: string
const: date
title: Type
slug:
type: string
title: Slug
description: '**Slug:** Storage key used for this custom field.'
name:
type: string
title: Name
description: Display name assigned to the custom field.
organization_id:
type: string
format: uuid4
title: Organization Id
description: Unique identifier for the organization owning the custom field.
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
x-ruba-selector-widget:
displayProperty: name
resourceName: Organization
resourceRoot: /v1/organizations
properties:
$ref: '#/components/schemas/CustomFieldDateProperties'
type: object
required:
- created_at
- modified_at
- id
- metadata
- type
- slug
- name
- organization_id
- properties
title: CustomFieldDate
description: Schema for a custom field of type date.
CustomFieldCheckbox:
properties:
created_at:
type: string
format: date-time
title: Created At
description: The time Ruba created this record.
modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Modified At
description: The time this record last changed.
id:
type: string
format: uuid4
title: Id
description: The stable identifier for this record.
metadata:
$ref: '#/components/schemas/MetadataOutputType'
type:
type: string
const: checkbox
title: Type
slug:
type: string
title: Slug
description: '**Slug:** Storage key used for this custom field.'
name:
type: string
title: Name
description: Display name assigned to the custom field.
organization_id:
type: string
format: uuid4
title: Organization Id
description: Unique identifier for the organization owning the custom field.
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
x-ruba-selector-widget:
displayProperty: name
resourceName: Organization
resourceRoot: /v1/organizations
properties:
$ref: '#/components/schemas/CustomFieldCheckboxProperties'
type: object
required:
- created_at
- modified_at
- id
- metadata
- type
- slug
- name
- organization_id
- properties
title: CustomFieldCheckbox
description: Schema for a custom field of type checkbox.
CustomFieldSelect:
properties:
created_at:
type: string
format: date-time
title: Created At
description: The time Ruba created this record.
modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Modified At
description: The time this record last changed.
id:
type: string
format: uuid4
title: Id
description: The stable identifier for this record.
metadata:
$ref: '#/components/schemas/MetadataOutputType'
type:
type: string
const: select
title: Type
slug:
type: string
title: Slug
description: '**Slug:** Storage key used for this custom field.'
name:
type: string
title: Name
description: Display name assigned to the custom field.
organization_id:
type: string
format: uuid4
title: Organization Id
description: Unique identifier for the organization owning the custom field.
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
x-ruba-selector-widget:
displayProperty: name
resourceName: Organization
resourceRoot: /v1/organizations
properties:
$ref: '#/components/schemas/CustomFieldSelectProperties'
type: object
required:
- created_at
- modified_at
- id
- metadata
- type
- slug
- name
- organization_id
- properties
title: CustomFieldSelect
description: Schema for a custom field of type select.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
CustomFieldTextProperties:
properties:
form_label:
type: string
minLength: 1
title: Form Label
form_help_text:
type: string
minLength: 1
title: Form Help Text
form_placeholder:
type: string
minLength: 1
title: Form Placeholder
textarea:
type: boolean
title: Textarea
min_length:
type: integer
maximum: 2147483647
minimum: 0
title: Min Length
max_length:
type: integer
maximum: 2147483647
minimum: 0
title: Max Length
type: object
title: CustomFieldTextProperties
CustomFieldNumberProperties:
properties:
form_label:
type: string
minLength: 1
title: Form Label
form_help_text:
type: string
minLength: 1
title: Form Help Text
form_placeholder:
type: string
minLength: 1
title: Form Placeholder
ge:
type: integer
maximum: 2147483647
minimum: -2147483648
title: Ge
le:
type: integer
maximum: 2147483647
minimum: -2147483648
title: Le
type: object
title: CustomFieldNumberProperties
CustomFieldDateProperties:
properties:
form_label:
type: string
minLength: 1
title: Form Label
form_help_text:
type: string
minLength: 1
title: Form Help Text
form_placeholder:
type: string
minLength: 1
title: Form Placeholder
ge:
type: integer
maximum: 2147483647
minimum: -2147483648
title: Ge
le:
type: integer
maximum: 2147483647
minimum: -2147483648
title: Le
type: object
title: CustomFieldDateProperties
CustomFieldCheckboxProperties:
properties:
form_label:
type: string
minLength: 1
title: Form Label
form_help_text:
type: string
minLength: 1
title: Form Help Text
form_placeholder:
type: string
minLength: 1
title: Form Placeholder
type: object
title: CustomFieldCheckboxProperties
CustomFieldSelectProperties:
properties:
form_label:
type: string
minLength: 1
title: Form Label
form_help_text:
type: string
minLength: 1
title: Form Help Text
form_placeholder:
type: string
minLength: 1
title: Form Placeholder
options:
items:
$ref: '#/components/schemas/CustomFieldSelectOption'
type: array
minItems: 1
title: Options
type: object
required:
- options
title: CustomFieldSelectProperties
MetadataOutputType:
additionalProperties:
anyOf:
- type: string
- type: integer
- type: number
- type: boolean
type: object
CustomFieldSelectOption:
properties:
value:
type: string
minLength: 1
title: Value
label:
type: string
minLength: 1
title: Label
type: object
required:
- value
- label
title: CustomFieldSelectOption
securitySchemes:
oidc:
type: openIdConnect
openIdConnectUrl: /.well-known/openid-configuration
pat:
type: http
description: >-
**Authentication:** You can generate a **Personal Access Token** from
your [settings](https://getruba.com/settings).
scheme: bearer
oat:
type: http
description: >-
**Authentication:** You can generate an **Organization Access Token**
from your organization's settings.
scheme: bearer
````