SMsmartling
Jobs

Create new custom field in account

Changed on

Creates new custom field in account.

post/jobs-api/v3/accounts/{accountUid}/custom-fields

Request

Path parameters

accountUidstring required

The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API.

Request body

typestring

custom field type.

fieldNameboolean

custom field name.

enabledboolean

is custom field enabled.

requiredboolean

is custom field required during job creation.

searchableboolean

can search be performed by the custom field.

displayToTranslatorsboolean

is displayed to translators.

optionsstring[]
defaultValuestring

default value for custom field.

descriptionstring

custom field description.

Example request

{
  "type": "SHORT_TEXT | LONG_TEXT | SELECTBOX | CHECKBOX",
  "fieldName": true,
  "enabled": true,
  "required": true,
  "searchable": true,
  "displayToTranslators": true,
  "options": [
    "option1"
  ],
  "defaultValue": "default field value",
  "description": "Custom field example"
}

Response

OK

Example response

{
  "data": {
    "fieldUid": "7a1f5c2e-3b9d-4e8a-9c64-2d0b8f1e5a37",
    "type": "SHORT_TEXT | LONG_TEXT | SELECTBOX | CHECKBOX",
    "fieldName": true,
    "enabled": true,
    "required": true,
    "searchable": true,
    "displayToTranslators": true,
    "options": [
      "option1"
    ],
    "defaultValue": "default field value",
    "description": "Custom field example"
  }
}

Changes

  • 2cd7a8215799Revision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

  • ae422098d9c5Revision changes
    • info

      endpoint added