Create Custom Field

Intent

Creates a custom field from the values supplied in the request.

When to call it

Call this when your application has collected the required values and is ready to create a custom field.

Access boundary

Authorize the request with a token that carries custom_fields:write.

Successful result

A successful request returns 201. The response schema below defines the body your integration receives.

Operational notes

Create a custom field.

Scopes: custom_fields:write

POST

custom-fields

Create Custom Field

curl --request POST \
  --url https://api.getruba.com/v1/custom-fields/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "text",
  "slug": "<string>",
  "name": "<string>",
  "properties": {
    "form_label": "<string>",
    "form_help_text": "<string>",
    "form_placeholder": "<string>",
    "textarea": true,
    "min_length": 1073741823,
    "max_length": 1073741823
  },
  "metadata": {},
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}
'

import requests

url = "https://api.getruba.com/v1/custom-fields/"

payload = {
    "type": "text",
    "slug": "<string>",
    "name": "<string>",
    "properties": {
        "form_label": "<string>",
        "form_help_text": "<string>",
        "form_placeholder": "<string>",
        "textarea": True,
        "min_length": 1073741823,
        "max_length": 1073741823
    },
    "metadata": {},
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'text',
    slug: '<string>',
    name: '<string>',
    properties: {
      form_label: '<string>',
      form_help_text: '<string>',
      form_placeholder: '<string>',
      textarea: true,
      min_length: 1073741823,
      max_length: 1073741823
    },
    metadata: {},
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  })
};

fetch('https://api.getruba.com/v1/custom-fields/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getruba.com/v1/custom-fields/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'text',
    'slug' => '<string>',
    'name' => '<string>',
    'properties' => [
        'form_label' => '<string>',
        'form_help_text' => '<string>',
        'form_placeholder' => '<string>',
        'textarea' => true,
        'min_length' => 1073741823,
        'max_length' => 1073741823
    ],
    'metadata' => [
        
    ],
    'organization_id' => '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getruba.com/v1/custom-fields/"

	payload := strings.NewReader("{\n  \"type\": \"text\",\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"properties\": {\n    \"form_label\": \"<string>\",\n    \"form_help_text\": \"<string>\",\n    \"form_placeholder\": \"<string>\",\n    \"textarea\": true,\n    \"min_length\": 1073741823,\n    \"max_length\": 1073741823\n  },\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getruba.com/v1/custom-fields/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"text\",\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"properties\": {\n    \"form_label\": \"<string>\",\n    \"form_help_text\": \"<string>\",\n    \"form_placeholder\": \"<string>\",\n    \"textarea\": true,\n    \"min_length\": 1073741823,\n    \"max_length\": 1073741823\n  },\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/custom-fields/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"text\",\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"properties\": {\n    \"form_label\": \"<string>\",\n    \"form_help_text\": \"<string>\",\n    \"form_placeholder\": \"<string>\",\n    \"textarea\": true,\n    \"min_length\": 1073741823,\n    \"max_length\": 1073741823\n  },\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "metadata": {},
  "type": "text",
  "slug": "<string>",
  "name": "<string>",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "properties": {
    "form_label": "<string>",
    "form_help_text": "<string>",
    "form_placeholder": "<string>",
    "textarea": true,
    "min_length": 1073741823,
    "max_length": 1073741823
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

You can generate an Organization Access Token from your organization's settings.

Body

application/json

CustomFieldCreateText
CustomFieldCreateNumber
CustomFieldCreateDate
CustomFieldCreateCheckbox
CustomFieldCreateSelect

Schema to create a custom field of type text.

type

string

required

Allowed value: "text"

slug

string

required

Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens.

Minimum string length: 1

Pattern: ^[a-z0-9-_]+$

name

string

required

Name of the custom field.

Minimum string length: 1

properties

CustomFieldTextProperties · object

required

Show child attributes

metadata

Metadata · object

Key-value object allowing you to store additional information.

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.

Show child attributes

organization_id

string<uuid4> | null

The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

Response

Custom field created.

CustomFieldText
CustomFieldNumber
CustomFieldDate
CustomFieldCheckbox
CustomFieldSelect

Schema for a custom field of type text.

created_at

string<date-time>

required

The time Ruba created this record.

modified_at

string<date-time> | null

required

The time this record last changed.

string<uuid4>

required

The stable identifier for this record.

metadata

object

required

Show child attributes

type

string

required

Allowed value: "text"

slug

string

required

Identifier of the custom field. It'll be used as key when storing the value.

name

string

required

Name of the custom field.

organization_id

string<uuid4>

required

The ID of the organization owning the custom field.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

properties

CustomFieldTextProperties · object

required

Show child attributes

Create Custom Field

curl --request POST \
  --url https://api.getruba.com/v1/custom-fields/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "text",
  "slug": "<string>",
  "name": "<string>",
  "properties": {
    "form_label": "<string>",
    "form_help_text": "<string>",
    "form_placeholder": "<string>",
    "textarea": true,
    "min_length": 1073741823,
    "max_length": 1073741823
  },
  "metadata": {},
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}
'

import requests

url = "https://api.getruba.com/v1/custom-fields/"

payload = {
    "type": "text",
    "slug": "<string>",
    "name": "<string>",
    "properties": {
        "form_label": "<string>",
        "form_help_text": "<string>",
        "form_placeholder": "<string>",
        "textarea": True,
        "min_length": 1073741823,
        "max_length": 1073741823
    },
    "metadata": {},
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'text',
    slug: '<string>',
    name: '<string>',
    properties: {
      form_label: '<string>',
      form_help_text: '<string>',
      form_placeholder: '<string>',
      textarea: true,
      min_length: 1073741823,
      max_length: 1073741823
    },
    metadata: {},
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  })
};

fetch('https://api.getruba.com/v1/custom-fields/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getruba.com/v1/custom-fields/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'text',
    'slug' => '<string>',
    'name' => '<string>',
    'properties' => [
        'form_label' => '<string>',
        'form_help_text' => '<string>',
        'form_placeholder' => '<string>',
        'textarea' => true,
        'min_length' => 1073741823,
        'max_length' => 1073741823
    ],
    'metadata' => [
        
    ],
    'organization_id' => '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getruba.com/v1/custom-fields/"

	payload := strings.NewReader("{\n  \"type\": \"text\",\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"properties\": {\n    \"form_label\": \"<string>\",\n    \"form_help_text\": \"<string>\",\n    \"form_placeholder\": \"<string>\",\n    \"textarea\": true,\n    \"min_length\": 1073741823,\n    \"max_length\": 1073741823\n  },\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getruba.com/v1/custom-fields/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"text\",\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"properties\": {\n    \"form_label\": \"<string>\",\n    \"form_help_text\": \"<string>\",\n    \"form_placeholder\": \"<string>\",\n    \"textarea\": true,\n    \"min_length\": 1073741823,\n    \"max_length\": 1073741823\n  },\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/custom-fields/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"text\",\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"properties\": {\n    \"form_label\": \"<string>\",\n    \"form_help_text\": \"<string>\",\n    \"form_placeholder\": \"<string>\",\n    \"textarea\": true,\n    \"min_length\": 1073741823,\n    \"max_length\": 1073741823\n  },\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "metadata": {},
  "type": "text",
  "slug": "<string>",
  "name": "<string>",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "properties": {
    "form_label": "<string>",
    "form_help_text": "<string>",
    "form_placeholder": "<string>",
    "textarea": true,
    "min_length": 1073741823,
    "max_length": 1073741823
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Read This First

Create a Sale

Collect and Reconcile

Manage Recurring Revenue

Model Customer Access

Power the Customer Portal

Configure the Platform

React to State Changes

Create Custom Field

Intent

When to call it

Access boundary

Successful result

Operational notes

Authorizations

Body

Response