Add item to surface | Runtype Documentation

Add a capability item to a surface.

AuthorizationBearer

API key or Clerk session token

idstringRequired

surfaceIdstringRequired

This endpoint expects an object.

capabilityIdstringRequired

enabledbooleanOptional

endpointSlugstringOptionalformat: "^[a-z0-9-]+$"<=100 characters

exposedDescriptionstringOptional

exposedNamestringOptional<=100 characters

isEntryPointbooleanOptional

presentationobjectOptional

Surface item added

capabilityIdstring

createdAtstring

displayOrderinteger or null

enabledboolean

endpointSlugstring or null

exposedDescriptionstring or null

exposedNamestring or null

idstring

isEntryPointboolean

surfaceIdstring

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/products/id/surfaces/surfaceId/items \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"capabilityId": "prodcap_abc123",
>	"exposedName": "answer-questions"
>	}'