Update webhook field mappings | Runtype Documentation

Update field mappings for a specific surface item.

AuthorizationBearer

API key or Clerk session token

idstringRequired

Product ID

surfaceIdstringRequired

Surface ID

This endpoint expects an object.

itemIdstringRequired

mappingslist of objectsRequired

Mappings updated

fieldMappingslist of any

idstring

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

$	curl -X PUT https://api.runtype.com/v1/products/id/surfaces/surfaceId/webhook-mappings \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"itemId": "prod_987654321",
>	"mappings": [
>	{
>	"source": "user_email",
>	"target": "emailAddress"
>	},
>	{
>	"source": "user_signup_date",
>	"target": "registrationDate"
>	},
>	{
>	"source": "is_active",
>	"target": "activeStatus"
>	}
>	]
>	}'

1	{
2	"fieldMappings": [
3	"user_email -> emailAddress",
4	"user_signup_date -> registrationDate",
5	"is_active -> activeStatus"
6	],
7	"id": "prod_987654321"
8	}

$	curl -X PUT https://api.runtype.com/v1/products/id/surfaces/surfaceId/webhook-mappings \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"itemId": "prod_987654321",
>	"mappings": [
>	{
>	"source": "user_email",
>	"target": "emailAddress"
>	},
>	{
>	"source": "user_signup_date",
>	"target": "registrationDate"
>	},
>	{
>	"source": "is_active",
>	"target": "activeStatus"
>	}
>	]
>	}'

1	{
2	"fieldMappings": [
3	"user_email -> emailAddress",
4	"user_signup_date -> registrationDate",
5	"is_active -> activeStatus"
6	],
7	"id": "prod_987654321"
8	}