AssetCenter
Sign in Get started - it's free!

↑ ↓ to navigate · ↵ to open See all results
POST /api/v1/subscription-categories/{category}/fields

Create a subscription category field

Add a custom-field definition to a subscription category.

Last updated

Request

POST /api/v1/subscription-categories/{category}/fields

Requires subscription-categories:create. The token creator must remain an active administrator of the token’s organization. Category permissions.

Send Authorization: Bearer YOUR_API_TOKEN and Accept: application/json.

category is the numeric ID of a subscription category in the token’s organization. Asset categories are unavailable here.

Query parameters

This endpoint does not use query parameters.

Request body

Field Type Required Description
name string Yes Field label, 2–255 characters.
type string Yes One of text, number, date, boolean, yesno, or phone. See the options endpoint for labels.
is_required boolean No Whether a subscription must supply a value. Defaults to false on creation. Always false for boolean fields, even when true is sent.

Requires Idempotency-Key. Generate one key per action and keep it for retries. Successful responses are remembered for 24 hours per token. Idempotency and retries.

Example

Set ASSETCENTER_API_TOKEN as described in the quick start. Replace example IDs with values from your organization. For a retry, reuse the original key instead of generating another UUID.

cURL / Bash 
curl --request POST "https://my.assetcenter.app/api/v1/subscription-categories/7/fields" \
  --header "Authorization: Bearer $ASSETCENTER_API_TOKEN" \
  --header "Accept: application/json" \
  --header "Idempotency-Key: $(uuidgen)" \
  --header "Content-Type: application/json" \
  --data '{"name":"License reference","type":"text"}'

Response

201 Created. Illustrative response; IDs and values will differ.

JSON 
{
  "data": {
    "id": 31,
    "category_id": 7,
    "name": "License reference",
    "type": "text",
    "is_required": false,
    "has_values": false,
    "can_delete": true,
    "can_change_type": true
  }
}

Responses describe the field definition and contain no subscription values. has_values includes a stored zero, a false checkbox, or any stored date or text. can_delete and can_change_type describe current data constraints; they do not grant token permissions. Use field IDs as keys in custom_fields when writing subscriptions. Custom-field values.

Behavior and constraints

A new field has no stored values. is_required defaults to false and is forced to false for type boolean. Adding a required field does not backfill existing subscriptions; the requirement applies when creating a subscription, changing its category, or submitting that field. Subscription values are written through subscription creation or subscription updates. Field IDs, category IDs, values, and display positions are not accepted in the body.

Errors

401 means the customer bearer token is missing, expired, revoked, or invalid. 403 means the required permission is missing or the token creator is no longer an active organization administrator. 404 means the category or field is unavailable in this organization. 422 identifies invalid or unsupported input. 429 means a rate limit was reached. Error handling and rate limits. 409 means conflicting key reuse or a data constraint described above.