Create a new component

POST

/components

• Production

Authorizations

• apiKey
• clientCredentials
• endUser
• endUserHashed

Request Body ^required

object

componentId

required

string

name

required

string

internal

string

internalPage

string

html

string

Responses

200

Successful response

object

envId

required

string

componentId

required

string

name

required

string

internal

required

string

internalPage

required

string

html

required

string

createdAt

required

string

modifiedAt

required

string

referencedBy

required

Array<object>

object

notificationId

required

string

channel

required

string

Allowed values: EMAIL INAPP_WEB SMS CALL PUSH WEB_PUSH SLACK

templateId

required

string

channel

required

string

Allowed values: EMAIL

400

Bad Request - validation errors, invalid input

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

provider

Provider that caused the error (e.g. telnyx, ses).

string

providerCode

Provider-specific error code.

string

401

Unauthorized

402

Payment Required - usage limits exceeded

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

provider

Provider that caused the error (e.g. telnyx, ses).

string

providerCode

Provider-specific error code.

string

500

Internal Server Error

502

Bad Gateway - provider error

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

provider

Provider that caused the error (e.g. telnyx, ses).

string

providerCode

Provider-specific error code.

string