curl --request POST \
--url https://api.railmail.app/api/v1/custom-fields \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"key": "company",
"displayName": "Company",
"type": "TEXT",
"isRequired": false
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"displayName": "<string>",
"description": "<string>",
"type": "<string>",
"status": "<string>",
"isSystem": true,
"isRequired": true,
"defaultValue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errors": {}
}Pola niestandardowe
Utwórz pole niestandardowe
Tworzy definicję pola niestandardowego. SELECT i MULTI_SELECT wymagają options. Wymagany zakres: custom_fields:write. Dzierżawa: ograniczone do projektu klucza API.
POST
/
api
/
v1
/
custom-fields
curl --request POST \
--url https://api.railmail.app/api/v1/custom-fields \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"key": "company",
"displayName": "Company",
"type": "TEXT",
"isRequired": false
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"displayName": "<string>",
"description": "<string>",
"type": "<string>",
"status": "<string>",
"isSystem": true,
"isRequired": true,
"defaultValue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"errors": {}
}Autoryzacje
Project-scoped API key, format rm_(live|test)_... . May also be sent as Authorization: Bearer rm_....
Treść
application/json
Maximum string length:
100Dostępne opcje:
TEXT, LONG_TEXT, NUMBER, DECIMAL, BOOLEAN, DATE, DATETIME, EMAIL, URL, PHONE, SELECT, MULTI_SELECT Maximum string length:
500Wymagane dla SELECT i MULTI_SELECT.
Show child attributes
Show child attributes