/api/v1/components/{id} (PATCH)

PATCH

/api/v1/components/{id}

curl --request PATCH \
  --url https://api.endless.zaia.app/api/v1/components/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "detail": { "type": "boolean", "value": true } }'

• API Server

Updates a component.

Parameters

Path Parameters

id

required

A UUID v4 string that identifies an entity.

string format: uuid

A UUID v4 string that identifies an entity.

Request Body^required

Media typeapplication/json

object

detail

Any of:

object

object

type

required

string

Allowed values: boolean

value

required

boolean

object

object

type

required

string

Allowed values: number

value

required

number

object

object

type

required

string

Allowed values: string

value

required

string

Responses

200

The component was updated.

Media typeapplication/json

object

createdAt

required

string format: date-time

id

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

detail

required

Any of:

object

object

type

required

string

Allowed values: boolean

value

required

boolean

object

object

type

required

string

Allowed values: number

value

required

number

object

object

type

required

string

Allowed values: string

value

required

string

key

required

The unique key identifier for this component within the workspace.

string

>= 1 characters <= 100 characters /^[a-zA-Z0-9_]+$/

workspaceId

required

The workspace that owns this component.

string format: uuid

Example

{
  "detail": {
    "type": "boolean"
  }
}

401

Unauthorized.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}

404

Component not found.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}

409

Component key already exists.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}