Release Candidate — the API is undergoing final validation before general availability, and minor changes may still occur.
Hellomateo API Documentation
Custom Fields

Update Custom Field

PATCH
/v1/custom-fields/{id}

Updates the specified custom Field.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Unique identifier for the resource.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?|

Human-readable description of the resource.

entity?"appointment" | "contact" | "deal"

Entity value for this resource.

key?string

Stable key used to identify the resource.

name?string

Human-readable name of the resource.

Length1 <= length
type?"boolean" | "date" | "datetime" | "number" | "string" | "string_list"

Type of the resource.

options?array<>|

Options value for this resource.

Response Body

application/json

curl -X PATCH "https://api.getmateo.com/v1/custom-fields/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "entity": "appointment",  "key": "string",  "name": "string",  "type": "boolean",  "options": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}