Skip to main content
PUT
/
api
/
v1
/
segments
/
{id}
Update
curl --request PUT \
  --url https://api.main.apexscore.ai/api/v1/segments/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "portfolio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "configuration_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "portfolio": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "configurations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "report_name": "<string>",
      "report_issued_at": "2023-11-07T05:31:56Z"
    }
  ],
  "description": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.apexscore.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this segment.

Body

application/json
​
name
string
required
Maximum string length: 255
​
portfolio_id
string<uuid>
required
write-only
​
description
string | null
​
configuration_ids
string<uuid>[]
write-only

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
name
string
required
Maximum string length: 255
​
portfolio
object
required
​
configurations
object[]
required
read-only
​
description
string | null