Shorter Loop API Documentation
API ReferencesRelease NotesHelp CenterKnowledge Base
API ReferencesRelease NotesHelp CenterKnowledge Base
Sign In
  1. Segments
  • Getting started
    • Welcome to the Shorter Loop API Portal
    • Authentication
    • Base URL
    • 2 way Jira Integration
    • Create webhook in Shorter Loop
  • Metrics
    • Create a Key Performance Indicator (KPI)
      POST
    • Update the Key Performance Indicator (KPI)
      PUT
    • Retrieve KPIs not linked to specific product backlog items
      GET
    • Insert KPI's records (Body JSON Payload)
      POST
    • Insert KPI's records (Upload CSV)
      POST
    • Insert KPI's records (Upload JSON)
      POST
  • Idea manager
    • Feedback Collection
      • Create idea and issue
      • Retrieves a list of categories
      • Modify feedback item
      • Removes a feedback item
      • Upvote or downvote a work item
      • Retrieve a feedback item
      • Get comments for a feedback item.
      • Reply to a comment
      • Modify a comment
      • Bulk create feedback items: CSV and JSON
    • Segments
      • Retrieves a list of segments without users
      • Create segment
      • Modify a segment
      • Removes a segment
      • Bulk create users to a segment
      • Manage user segments: move or remove
      • Retrieve segments with users
      • Retrieve segment with users
      • Import Users (CSV/JSON)
      • Sending email to segment members
      • Sending email to selected idm members
    • Bulk create idea manager members
    • Import Users (CSV/JSON) in IDM
    • Bulk re-invite in IDM
  • Backlog Management
    • Epics
      • Create a new epic
      • Modify an epic
      • Retrieve details of the epic
      • Removes the epic
    • Features
      • Create a new feature
      • Modify a feature
      • Retrieve details of the feature
      • Removes the feature
    • User stories
      • Create a new user story
      • Modify a user story
      • Retrieve user story
      • Removes the user story
    • Assets
      • Attaches files to the workitem
      • Removes an asset
      • Retrieve attachments for the backlog workitem with ID
    • Product Tags
      • Retrieves tags for initiative
    • Teams
      • Get teams and members for product
    • Personas
      • Retrieve personas associated with initiative
    • Get whole backlog tree
  • Strategy Board
    • Experiment
      • Create a new experiemnt variant
    • Solutions
      • Versions
        • Storymap versions api documentation
        • Create a version
        • Update version
        • Removes a version
        • Retrieve versions
      • Get all storymaps for solution
  • Persona Board V2
    • Segments
      • Permanently deletes a segment
        DELETE
      • Creates a new option
        POST
      • Retrieve a list of segments
        GET
      • Retrieve a segment
        GET
      • Create a segment
        POST
      • Removes a segment
        DELETE
      • Removes a segment option
        DELETE
      • Detaches a segment from the persona
        PATCH
      • Update segment option
        PATCH
    • Custom fields
      • Removes a custom field
      • Retrieve a list of custom fields
      • Retrieve a custom field
      • Create a custom field
      • Removes a custom field option
      • Detaches a custom field from persona
      • Retrieve custom fields excluding persona
      • Creates a new option
      • Permanently deletes a custom field
      • Update custom field
      • Update custom field option
      • Attach a custom field to a persona
    • Create opportunities from summary
      POST
    • Retrieve notes
      GET
    • Retrieve persona
      GET
    • Retrieve experiments for Persona
      GET
    • Create
      POST
    • Retrieve
      GET
  • DocsHub
    • Retrieve categories with templates
    • Retrieve a template based on category
    • Create copy of template while using template
  1. Segments

Update segment option

PATCH
/api/v2/persona/PE-1/segments/34/options/1
v2

Request

Header Params
Authorization
string 
required
Content-Type
string 
required
Example:
application/json
initiativeId
string 
required
Example:
DRA
subscriptionId
string 
required
Example:
SSS
Body Params application/json
name
string 
required
value
string 
required
Example
{
    "name": "culpa dolorum ut",
    "value": "commodo irure"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.shorterloop.com/api/v2/persona/PE-1/segments/34/options/1' \
--header 'Authorization;' \
--header 'Authorization;' \
--header 'initiativeId: DRA' \
--header 'initiativeId;' \
--header 'subscriptionId: SSS' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "culpa dolorum ut",
    "value": "commodo irure"
}'

Responses

🟢200OK
application/json
Body
success
boolean 
required
message
string 
required
data
array [object {7}] 
required
id
integer 
required
name
string 
required
value
null 
required
fieldId
integer 
required
selectedCustomFieldOptionId
integer 
required
selectedOptionValue
string  | null 
required
custom_field_options
array [object {2}] 
required
Example
{
    "success": true,
    "message": "string",
    "data": [
        {
            "id": 0,
            "name": "string",
            "value": null,
            "fieldId": 0,
            "selectedCustomFieldOptionId": 0,
            "selectedOptionValue": "string",
            "custom_field_options": [
                {
                    "id": 0,
                    "value": "string"
                }
            ]
        }
    ]
}
Modified at 2024-09-11 12:06:54
Previous
Detaches a segment from the persona
Next
Removes a custom field
Built with