Newscred Settings API

openapi: 3.2.0
info:
  title: Newscred Settings API
  version: V3
  description: 'Operations tagged Settings across 2 of this provider''s published API definitions: newscred-cmp-open-api-openapi.json, newscred-welcome-open-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: v3 version of Optimizely CMP Open API
  url: https://api.cmp.optimizely.com/v3
- url: https://api.welcomesoftware.com/v3
  description: v3 version of _Welcome_ Open API
tags:
- name: Settings
paths:
  /settings:
    get:
      description: <span style="background-color:#e95f6a;padding:5px;border-radius:5px">Experimental</span> Get settings.
      operationId: getSettings
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Settings'
          description: Fetched settings
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      summary: GET /settings
      tags:
      - Settings
      security:
      - OAuth2:
        - openid
        - profile
        - offline_access
    post:
      description: "<span style=\"background-color:#e95f6a;padding:5px;border-radius:5px\">Experimental</span> Create or update settings.\n## Import behavior:\n- Label:\n    - If a label-group with the same name exists, the label-group is updated.\n      - Labels are merged.\n      - If a label with the same name exists, it is overwritten.\n    - If no label-group with the same name exists, a new label-group is created.\n- Custom Fields:\n    - If a custom field with the same name exists, the custom field is updated and its choices are merged.\n    - If no custom field with the same name exists, a new custom field will be created.\n- Workflows:\n    - If the query param overwrite_workflows=true the existing workflows are overwritten.\n      Otherwise, a new workflow will be created where the prefix `Copy of` is added to the name of the workflow.\n- Webhooks:\n    - If a webhook with the same name exists, the webhook is updated and its events are merged.\n    - If multiple webhooks with the same name exist, a new webhook is created.\n    - If no webhook with the same name exists, a new webhook is created.\n- Apps:\n    - If an app with the same name exists, the app is updated and its authorization callback URLs are merged.\n    - If multiple apps with the same name exist, a new app is created.\n    - If no app with the same name exists, a new app is created.\n- Templates:\n    - If a template with the same name exists, the template is updated.\n    - If multiple templates with the same name exist, a new template is created.\n    - If no template with the same name exists, a new template is created.\n- Routing Rules:\n    - If one single routing rule with the same name exists, the routing rule is updated.\n    - If multiple routing rules with the same name exist, a new routing rule is created.\n    - If no routing rule with the same name exists, a new routing rule is created.\n"
      operationId: updateSettings
      parameters:
      - description: If `execute=true` the settings are created or updated. Otherwise, the endpoint returns only the changeset.
        example: true
        in: query
        name: execute
        required: false
        schema:
          type: boolean
      - description: If `overwrite_workflows=true` the existing workflows are overwritten. Otherwise, a new workflow is created where a prefix `Copy of` is added to the workflow's name.
        example: true
        in: query
        name: overwrite_workflows
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettingsResources'
        description: Payload to create or update settings
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsUpdateResponse'
          description: Created or updated settings and changeset
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      summary: POST /settings
      tags:
      - Settings
      security:
      - OAuth2:
        - openid
        - profile
        - offline_access
    servers:
    - description: v3 version of Optimizely CMP Open API
      url: https://api.cmp.optimizely.com/v3
components:
  schemas:
    Section:
      additionalProperties: false
      properties:
        id:
          description: Id of the template section
          example: 9ec506f480dbc2d5f6919168ae448c41
          type: string
        label:
          description: Name of the template section
          example: Test section
          type: string
      required:
      - label
      - id
      type: object
    WorkflowChannel:
      additionalProperties: false
      properties:
        display_name:
          description: Name of the channel
          example: exampleChannel
          type: string
        type:
          description: Type of channel
          example: twitter
          type: string
      required:
      - display_name
      - type
      type: object
    SettingsCustomField:
      additionalProperties: false
      description: Settings for custom fields
      properties:
        checkbox:
          description: List of checkbox custom fields
          items:
            $ref: '#/components/schemas/MultipleOptionCustomField'
          type: array
        currency:
          description: List of currency custom fields
          items:
            $ref: '#/components/schemas/CurrencyCustomField'
          type: array
        date:
          description: List of date custom fields
          items:
            $ref: '#/components/schemas/LabelOnlyCustomField'
          type: array
        dropdown:
          description: List of dropdown custom fields
          items:
            $ref: '#/components/schemas/MultipleOptionCustomField'
          type: array
        image:
          description: List of image custom fields
          items:
            $ref: '#/components/schemas/LabelOnlyCustomField'
          type: array
        multi_select_dropdown:
          description: List of multi-select dropdown custom fields
          items:
            $ref: '#/components/schemas/MultipleOptionCustomField'
          type: array
        multichoice:
          description: List of multichoice custom fields
          items:
            $ref: '#/components/schemas/MultipleOptionCustomField'
          type: array
        number:
          description: List of number custom fields
          items:
            $ref: '#/components/schemas/NumberCustomField'
          type: array
        percentage:
          description: List of percentage custom fields
          items:
            $ref: '#/components/schemas/PercentageCustomField'
          type: array
        richtext:
          description: List of rich text custom fields
          items:
            $ref: '#/components/schemas/LabelOnlyCustomField'
          type: array
        string:
          description: List of string custom fields
          items:
            $ref: '#/components/schemas/LabelOnlyCustomField'
          type: array
        textarea:
          description: List of textarea custom fields
          items:
            $ref: '#/components/schemas/LabelOnlyCustomField'
          type: array
        video:
          description: List of video custom fields
          items:
            $ref: '#/components/schemas/LabelOnlyCustomField'
          type: array
      required:
      - currency
      - number
      - percentage
      - checkbox
      - dropdown
      - multichoice
      - multi_select_dropdown
      - date
      - image
      - richtext
      - string
      - textarea
      - video
      type: object
    CurrencyCustomField:
      additionalProperties: false
      properties:
        currency_code:
          default: USD
          description: Curency code of custom field
          example: USD
          type: string
        decimal_places:
          default: null
          description: Value of decimal places
          example: 1
          type:
          - integer
          - 'null'
        has_thousand_separator:
          default: false
          description: Indicator of thousand separator
          example: false
          type: boolean
        label:
          description: Name of the custom field
          example: A Currency Custom Field
          type: string
      required:
      - label
      - decimal_places
      - currency_code
      - has_thousand_separator
      type: object
    FormField:
      additionalProperties: false
      properties:
        custom_field_type:
          description: Type of the custom field when the form field is a custom field
          example: multichoice
          type:
          - string
          - 'null'
        field_type:
          description: Type of template form field
          example: custom_field
          type: string
        help:
          description: Helper text for form field
          example: This is a helper text
          type: string
        identifier:
          description: Identifier of the form field
          example: SingleChoice1
          type: string
        is_required:
          description: Indicates whether the form field is required
          example: false
          type: boolean
        logic_rules:
          description: List of the template logic rules
          items:
            $ref: '#/components/schemas/LogicRule'
          type: array
        sort_order:
          description: Sort order of the form field
          example: 0
          type: integer
      required:
      - field_type
      - help
      - is_required
      - logic_rules
      - sort_order
      - identifier
      - custom_field_type
      type: object
    SettingsTemplate:
      additionalProperties: false
      properties:
        description:
          description: Description of the template
          example: Template description
          type: string
        form_fields:
          description: List of the template form_fields
          items:
            $ref: '#/components/schemas/FormField'
          type: array
        instructions:
          description: List of the template instructions
          items:
            $ref: '#/components/schemas/Instruction'
          type: array
        name:
          description: Name of the template
          example: Template 1
          type: string
        public_description:
          description: Public description of the template
          example: Template public description
          type: string
        sections:
          description: List of the template sections
          items:
            $ref: '#/components/schemas/Section'
          type: array
        types:
          description: List of areas where you can use the template
          example:
          - campaign_brief
          - task_brief
          - work_request
          items:
            example: campaign_brief
            type: string
          type: array
      required:
      - name
      - description
      - public_description
      - form_fields
      - sections
      - instructions
      - types
      type: object
    LogicRule:
      additionalProperties: false
      properties:
        action:
          $ref: '#/components/schemas/LogicRuleAction'
          description: Template logic rule action
          type: object
        condition:
          $ref: '#/components/schemas/LogicRuleCondition'
          description: Logic rule action associated condition
          type: object
      required:
      - action
      - condition
      type: object
    Instruction:
      additionalProperties: false
      properties:
        description:
          description: Description of the template instruction
          example: Test instruction description
          type: string
        id:
          description: Id of the template instruction
          example: 9ec506f480dbc2d5f6919168ae448c40
          type: string
      required:
      - description
      - id
      type: object
    SettingsChangeset:
      additionalProperties: false
      properties:
        create:
          $ref: '#/components/schemas/SettingsChangesetBase'
          description: Created settings
          type: object
        update:
          $ref: '#/components/schemas/SettingsChangesetBase'
          description: Updated settings
          type: object
      required:
      - create
      - update
      type: object
    LabelOnlyCustomField:
      additionalProperties: false
      properties:
        label:
          description: Name of the custom field
          example: A Custom Field
          type: string
      required:
      - label
      type: object
    WorkflowCustomfield:
      additionalProperties: false
      properties:
        default_value:
          default: []
          description: List of the custom field choices
          example:
          - choice1
          - choice2
          items:
            example: choice1
            type: string
          type: array
        field:
          description: Name of the custom field
          example: exampleCustomField
          type: string
        is_required:
          description: Indicates whether a custom field is required
          example: false
          type: boolean
        type:
          description: Type of custom field
          example: equal
          type: string
      required:
      - is_required
      - field
      - default_value
      - type
      type: object
    LogicRuleCondition:
      additionalProperties: false
      description: Logic rule action associated condition
      properties:
        operator:
          description: The operator for logic rule action
          example: equal
          type: string
        values:
          description: List of labels or custom field choices
          example:
          - choice1
          items:
            example: choice1
            type: string
          type: array
      required:
      - operator
      - values
      type: object
    LogicRuleAction:
      additionalProperties: false
      description: Template logic rule action
      properties:
        target_field:
          $ref: '#/components/schemas/LogicRuleTargetField'
          type: object
        type:
          description: Type of logic rule action
          example: jump_to
          type: string
        values:
          description: Values to consider on logic rule action
          example: []
          items:
            example: a choice
            type: string
          type: array
      required:
      - target_field
      - type
      - values
      type: object
    SettingsLabelGroup:
      additionalProperties: false
      properties:
        has_single_value:
          description: Single or multiple value support indicator for the label group
          example: true
          type: boolean
        label_type:
          description: Name of the label group
          example: Content Pillar
          type: string
        labels:
          description: List of labels of the label group
          items:
            $ref: '#/components/schemas/SettingsLabelGroupLabel'
          type: array
      required:
      - has_single_value
      - label_type
      - labels
      type: object
    MultipleOptionCustomField:
      additionalProperties: false
      properties:
        choices:
          description: Custom field choices
          example:
          - choice1
          - choice2
          items:
            example: choice1
            type: string
          type: array
        label:
          description: Name of the custom field
          example: A custom field with choice
          type: string
      required:
      - label
      - choices
      type: object
    SettingsResources:
      additionalProperties: false
      properties:
        apps:
          description: Settings apps
          items:
            $ref: '#/components/schemas/SettingsApp'
          type: array
        custom_fields:
          $ref: '#/components/schemas/SettingsCustomField'
          type: object
        labels:
          description: Settings labels
          items:
            $ref: '#/components/schemas/SettingsLabelGroup'
          type: array
        routing_rules:
          description: Settings routing rules
          items:
            $ref: '#/components/schemas/SettingsRoutingRule'
          type: array
        templates:
          description: Settings templates
          items:
            $ref: '#/components/schemas/SettingsTemplate'
          type: array
        webhooks:
          description: Settings webhooks
          items:
            $ref: '#/components/schemas/SettingsWebhook'
          type: array
        workflows:
          description: Settings workflows
          items:
            $ref: '#/components/schemas/SettingsWorkflow'
          type: array
      required:
      - labels
      - custom_fields
      - workflows
      - templates
      - apps
      - webhooks
      - routing_rules
      type: object
    Settings:
      additionalProperties: false
      properties:
        resources:
          $ref: '#/components/schemas/SettingsResources'
          description: Fetched settings
          type: object
      required:
      - resources
      type: object
    PercentageCustomField:
      additionalProperties: false
      properties:
        decimal_places:
          default: null
          description: Value of decimal places
          example: 1
          type:
          - integer
          - 'null'
        label:
          description: Name of the custom field
          example: A Percentage Custom Field
          type: string
      required:
      - label
      - decimal_places
      type: object
    WorkflowStep:
      additionalProperties: false
      properties:
        description:
          default: null
          description: Description of the workflow step
          example: This is a dummy example
          type:
          - string
          - 'null'
        duration:
          default: null
          description: Duration of the workflow step
          example: 1
          type:
          - integer
          - 'null'
        label:
          description: Name of the workflow step
          example: Step 1
          type: string
        substeps:
          description: List of the substeps
          items:
            $ref: '#/components/schemas/WorkflowSubStep'
          type: array
      required:
      - label
      - substeps
      - description
      - duration
      type: object
    SettingsLabelGroupLabel:
      additionalProperties: false
      properties:
        color:
          default: null
          description: Color of the label
          example: '#4ECFD5'
          type:
          - string
          - 'null'
        name:
          description: Name of the label
          example: Pillar1
          type: string
      required:
      - name
      - color
      type: object
    SettingsUpdateResponse:
      additionalProperties: false
      properties:
        changeset:
          $ref: '#/components/schemas/SettingsChangeset'
          description: Changeset of created or updated settings
          type: object
        resources:
          $ref: '#/components/schemas/SettingsResources'
          description: Created or updated settings
          type: object
      required:
      - resources
      - changeset
      type: object
    Error:
      additionalProperties: true
      description: Error payload
      properties:
        errors:
          additionalProperties: true
          description: Additional information
          properties: {}
          type: object
        message:
          description: Message describing the error
          example: Not found
          type: string
      required:
      - message
      type: object
    WorkflowSubStep:
      additionalProperties: false
      properties:
        actions:
          description: List of actions
          example:
          - findContent
          - writeEditSocialPost
          items:
            example: findContent
            type: string
          type: array
        description:
          default: null
          description: Description of the substep
          example: This is a substep description
          type:
          - string
          - 'null'
        external_sub_step_config:
          additionalProperties: false
          description: External substep configuration
          properties:
            is_user_interaction_allowed:
              default: false
              description: Indicates whether the user interaction is allowed
              example: false
              type: boolean
          type: object
        external_system:
          default: null
          description: Name of the external system if the substep is external
          example: null
          type:
          - string
          - 'null'
        is_external:
          default: false
          description: Indicates whether a substep is external
          example: false
          type:
          - boolean
          - 'null'
        label:
          default: null
          description: Name of the substep
          example: Substep 1
          type:
          - string
          - 'null'
      required:
      - actions
      - label
      - is_external
      - external_system
      - description
      type: object
    NumberCustomField:
      additionalProperties: false
      properties:
        decimal_places:
          description: Value of decimal places
          example: 1
          type:
          - integer
          - 'null'
        has_thousand_separator:
          default: false
          description: Indicator of thousand separator
          example: false
          type: boolean
        label:
          description: Name of the custom field
          example: A Number Custom Field
          type: string
      required:
      - label
      - decimal_places
      - has_thousand_separator
      type: object
    WorkflowLabel:
      additionalProperties: false
      properties:
        default_value:
          description: List of label names
          example:
          - label1
          - label2
          items:
            example: label1
            type: string
          type: array
        is_required:
          description: Indicates whether a label is required
          example: true
          type: boolean
        is_required_at_task_creation:
          description: Indicates whether a label is required at task creation
          example: false
          type: boolean
        label_type:
          description: Name of the Label Group
          example: Content Pillar
          type: string
      required:
      - default_value
      - is_required
      - label_type
      - is_required_at_task_creation
      type: object
    LogicRuleTargetField:
      additionalProperties: false
      description: Template logic rule action's target field
      properties:
        custom_field_type:
          default: null
          description: Type of custom field if the target field is a custom field
          example: null
          type:
          - string
          - 'null'
        identifier:
          description: Name of the target field identifier
          example: end_of_form
          type: string
        type:
          description: Type of the target field identifier
          example: end_of_form
          type: string
      required:
      - identifier
      - custom_field_type
      - type
      type: object
    SettingsRoutingRule:
      additionalProperties: false
      properties:
        description:
          description: Description of the routing rule
          example: Sample routing rule description
          type: string
        name:
          description: Name of the routing rule
          example: example Routing Rule
          type: string
        rules:
          description: List of the associated rules
          items:
            additionalProperties: false
            properties:
              custom_field_type:
                description: Associated custom field type
                example: multichoice
                type:
                - string
                - 'null'
              field_type:
                description: Name of the rule field type
                example: customField
                type: string
              identifier:
                description: Name of the rule identifier
                example: exampleCustomField1
                type:
                - string
                - 'null'
              operator:
                description: Name of the rule operator
                example: equal
                type: string
              unit:
                description: Unit of rule's field. Not null when the rule's `field_type` value is `dueDate`
                enum:
                - days
                - weeks
                - months
                - years
                - null
                example: days
                type:
                - string
                - 'null'
              value:
                description: List of the associated label, custom field, or due date choice
                example:
                - value1
                - value2
                items:
                  example: value1
                  type: string
                type: array
            required:
            - field_type
            - identifier
            - operator
            - value
            - unit
            - custom_field_type
            type: object
          type: array
        template_name:
          description: Name of the associated template
          example: Sample template name
          type:
          - string
          - 'null'
        watchers:
          description: List of the routing rule watchers email
          example:
          - examplewatcher@gmail.com
          items:
            example: examplewatcher@gmail.com
            type: string
          type: array
      required:
      - name
      - rules
      - watchers
      - description
      - template_name
      type: object
    SettingsChangesetBase:
      additionalProperties: false
      properties:
        apps:
          description: List of the app names
          example:
          - A App
          items:
            example: A App
            type: string
          type: array
        custom_fields:
          description: List of the custom field names
          example:
          - A Custom Field
          items:
            example: A Custom Field
            type: string
          type: array
        labels:
          description: List of the label names
          example:
          - A LabelGroup
          items:
            example: A LabelGroup
            type: string
          type: array
        routing_rules:
          description: List of the routing rule names
          example:
          - A routing Rule
          items:
            example: A routing Rule
            type: string
          type: array
        templates:
          description: List of the template names
          example:
          - A Template
          items:
            example: A Template
            type: string
          type: array
        webhooks:
          description: List of the webhook names
          example:
          - A Webhook
          items:
            example: A Webhook
            type: string
          type: array
        workflows:
          description: List of the workflow names
          example:
          - A WorkFlow
          items:
            example: A WorkFlow
            type: string
          type: array
      required:
      - labels
      - custom_fields
      - workflows
      - webhooks
      - apps
      - templates
      - routing_rules
      type: object
    SettingsWorkflow:
      additionalProperties: false
      properties:
        blacklisted_channels:
          description: List of the disallowed channels
          items:
            $ref: '#/components/schemas/WorkflowChannel'
          type: array
        custom_fields:
          description: List of the associated custom field
          items:
            $ref: '#/components/schemas/WorkflowCustomfield'
          type: array
        default_channels:
          description: List of the associated channels
          items:
            $ref: '#/components/schemas/WorkflowChannel'
          type: array
        description:
          default: null
          description: Description of the workflow
          example: Sample description
          type:
          - string
          - 'null'
        is_flexible_workflow:
          description: Indicates whether the workflow is flexible
          example: false
          type: boolean
        is_not_pushed_to_library_by_default:
          description: Indicates whether the contents of the task created from this workflow are not pushed to the library by default
          example: false
          type: boolean
        is_released_as_asset:
          description: Indicates whether the contents of the task created from this workflow are released as an asset
          example: false
          type: boolean
        labels:
          description: List of the associated labels
          items:
            $ref: '#/components/schemas/WorkflowLabel'
          type: array
        name:
          description: Name of the workflow
          example: A Workflow
          type: string
        steps:
          description: List of the workflow steps
          items:
            $ref: '#/components/schemas/WorkflowStep'
          type: array
      required:
      - is_flexible_workflow
      - is_not_pushed_to_library_by_default
      - is_released_as_asset
      - name
      - labels
      - custom_fields
      - default_channels
      - blacklisted_channels
      - steps
      - description
      type: object
    SettingsWebhook:
      additionalProperties: false
      properties:
        callback_url:
          description: Callback URL of the webhook
          example: https://exampledomain.com
          type: string
        description:
          description: Description of the webhook
          example: Sample description
          type: string
        event_names:
          description: List of the subscribed event names for the webhook
          example:
          - asset_added
          - asset_removed
          items:
            example: asset_added
            type: string
          type: array
        name:
          description: Name of the webhook
          example: Webhook 1
          type: string
        secret:
          description: Webhook callback URL secret
          example: secret121
          type: string
      required:
      - name
      - description
      - callback_url
      - secret
      - event_names
      type: object
    SettingsApp:
      additionalProperties: false
      properties:
        authorization_callback_urls:
          description: List of the authorization callback URLs
          example:
          - https://example1.com
          - https://example2.com
          items:
            example: https://example1.com
            type: string
          type: array
        description:
          description: Description of the app
          example: Sample description
          type: string
        env:
          description: Environment of the app
          example: production
          type: string
        expose_email:
          description: Indicates whether an email should be exposed in an API response
          example: true
          type: boolean
        homepage_url:
          description: Home page URL for app
          example: https://example1.com
          type: string
        name:
          description: Name of the app
          example: App 1
          type: string
      required:
      - name
      - description
      - homepage_url
      - authorization_callback_urls
      - expose_email
      - env
      type: object
    SettingMultipleOptionCustomField:
      type: object
      additionalProperties: false
      properties:
        label:
          type: string
          description: Name of the customfield
          example: A CustomField With Choice
        choices:
          type: arra

# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/newscred/refs/heads/main/openapi/newscred-settings-api-openapi.yml