POST
/
partner
/
schema-definitions
/
{schemaIdOrName}
Update Schema
curl --request POST \
  --url https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName} \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "schema": {},
  "fieldsToExpose": [
    {
      "name": "<string>",
      "description": "<string>",
      "jsonPath": "<string>",
      "exposure": [
        "segments"
      ]
    }
  ],
  "exposeNameJsonPath": "<string>",
  "external_id_field": "<string>",
  "externalIdField": "<string>",
  "category": "contacts_schema"
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "plural_name": "<string>",
    "pluralName": "<string>",
    "description": "<string>",
    "category": "contacts_schema",
    "version_number": 123,
    "versionNumber": 123,
    "partner_db_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "partnerDbId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "partner_db_query": "<string>",
    "partnerDbQuery": "<string>",
    "reference_schemas": [
      "<string>"
    ],
    "referenceSchemas": [
      "<string>"
    ],
    "schema": {},
    "external_id_field": "<string>",
    "externalIdField": "<string>",
    "deactivated_at": "<string>",
    "deactivatedAt": "<string>",
    "created_at": "<string>",
    "createdAt": "<string>",
    "updated_at": "<string>",
    "updatedAt": "<string>"
  }
}

Path Parameters

schemaIdOrName
string
required

The ID or name of the schema definition to update

Body

application/json

Response

200
application/json

Status 200 response

The response is of type object.