Pular para o conteúdo
ZaiaZaiaZaia

/api/v1/components (POST)

POST
/api/v1/components
curl --request POST \
  --url https://api.endless.zaia.app/api/v1/components \
  --header 'Content-Type: application/json' \
  --data '{ "detail": { "type": "boolean", "value": true }, "key": "example" }'

Creates a new component.

Request Bodyrequired

Seção intitulada “Request Bodyrequired”
Media typeapplication/json
object
detail
required
Any of:
object
type
required
string
Allowed values: boolean
value
required
boolean
key
required

The unique key identifier for this component within the workspace.

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

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

The component was created.

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
type
required
string
Allowed values: boolean
value
required
boolean
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

Seção intitulada “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"
  }
}

409

Seção intitulada “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"
  }
}