Update item

This endpoint can be used to update properties on the Item.

Path Parameters

item_id string required

application/json

Request Body required

name string nullable
external_connections object[] nullable
Array [
external_connection_name object required
oneOf
string
string
---
string
string
external_entity_id string required
]

Responses

• 200
• 400
• 401
• 404
• 409
• 413
• 429
• 500

---

OK

Response Headers

application/json

Schema

Example (from schema)

---

Schema

id string required
name string required
created_at date-time required
external_connections object[] required
Array [
external_connection_name object required
oneOf
string
string
---
string
string
external_entity_id string required
]

{
  "id": "string",
  "name": "string",
  "created_at": "2024-12-20T17:17:33.433Z",
  "external_connections": [
    {
      "external_connection_name": "stripe",
      "external_entity_id": "string"
    }
  ]
}

Bad Request

Response Headers

application/json

Schema

Example (from schema)

---

Schema

oneOf
ConstraintViolationError
DuplicateResourceCreationError
RequestValidationError
---
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#400-constraint-violation]
status integer required
Possible values: [400]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation]
status integer required
Possible values: [400]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#400-request-validation-errors]
status integer required
Possible values: [400]
detail string nullable
title string nullable
validation_errors undefined[] required

{}

Unauthorized

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#401-authentication-error]

status integer required

Possible values: [401]

detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#401-authentication-error",
  "status": 401,
  "detail": "string",
  "title": "string"
}

Not Found

Response Headers

application/json

Schema

Example (from schema)

---

Schema

oneOf
FeatureNotAvailableError
ResourceNotFoundError
URLNotFound
---
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#404-feature-not-available]
status integer required
Possible values: [400]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#404-resource-not-found]
status integer required
Possible values: [404]
detail string nullable
title string required
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#404-url-not-found]
status integer required
Possible values: [404]
detail string nullable
title string nullable

{}

Conflict

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#409-resource-conflict]

status integer required

Possible values: [409]

detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#409-resource-conflict",
  "status": 409,
  "detail": "string",
  "title": "string"
}

Request Entity Too Large

Response Headers

application/json

Schema

Example (from schema)

---

Schema

oneOf
RequestTooLargeError
ResourceTooLargeError
TooManyResultsError
---
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#413-request-too-large]
status integer required
Possible values: [413]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#413-resource-too-large]
status integer required
Possible values: [413]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#413-too-many-results]
status integer required
Possible values: [413]
detail string nullable
title string nullable

{}

Too Many Requests

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#429-too-many-requests]

status integer required

Possible values: [429]

detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#429-too-many-requests",
  "status": 429,
  "detail": "string",
  "title": "string"
}

Internal Server Error

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#500-internal-server-error]

status integer required
detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#500-internal-server-error",
  "status": 0,
  "detail": "string",
  "title": "string"
}

Loading...