Options

Retrieve valid metadata field values for this company

Returns the allowed values for product_lines, business_units, company_departments, distribution_selection, custom_trigger_field_1-10 (with their human-readable labels), and custom_fields (company-specific metadata fields with their allowed values and required flags). Always call this before asking the user to fill in any of those fields. Present the returned values as a numbered or bulleted list and let the user pick one or more. Fields with an empty values array have no restriction — any value is accepted.

get/v1/options

Request

  • Base URL: https://api.blee.com
  • URL: https://api.blee.com/v1/options
  • Auth: HTTP bearer

Response

Valid options for the authenticated company.

product_linesstring[] required
business_unitsstring[] required
company_departmentsstring[] required
distribution_selectionstring[] required

Static enum values valid for all companies.

custom_trigger_fieldsobject required

Keyed by custom_trigger_field_1 … custom_trigger_field_10. Always includes all 10 slots; slots with no configuration have label: null and values: [].

custom_fieldsobject required

Company-specific fields for metadata.custom_fields in bundle submissions. Keys are the exact field names expected by the API. values lists allowed enum options (empty = free-form text). required indicates the field must be included in API submissions. Empty object for clients without a configured strategy.

Example response

{
  "custom_trigger_fields": {
    "custom_trigger_field_1": {
      "label": "Campaign Type",
      "values": [
        "Brand",
        "Performance"
      ]
    },
    "custom_trigger_field_2": {
      "label": null,
      "values": []
    }
  },
  "custom_fields": {
    "bettermentUploadType": {
      "values": [
        "Asset Submission",
        "Promotion",
        "Product UX",
        "Award"
      ],
      "required": true
    },
    "bettermentPurposeOfSubmission": {
      "values": [
        "New Creative",
        "Material Change",
        "Periodic Review"
      ],
      "required": false
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.