PATCH
/
api
/
resources
/
{schemaDefinitionNameOrId}
/
{externalId}
Patch Resource
curl --request PATCH \
  --url https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/{externalId} \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {}
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "result": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schema_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource_external_id": "<string>",
      "resourceExternalId": "<string>",
      "created_at": "<string>",
      "createdAt": "<string>",
      "updated_at": "<string>",
      "updatedAt": "<string>",
      "data": {}
    },
    "included": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schema_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "resource_external_id": "<string>",
        "resourceExternalId": "<string>",
        "created_at": "<string>",
        "createdAt": "<string>",
        "updated_at": "<string>",
        "updatedAt": "<string>",
        "data": {}
      }
    ]
  }
}

Headers

​
reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Path Parameters

​
schemaDefinitionNameOrId
string
required

The name or id of the schema definition for the resource being updated

​
externalId
string
required

The external ID of the resource to update

Query Parameters

​
ignoreUnknownFields
boolean | null
default:false

Whether to allow extra fields that are not defined in the schema. If true, extra fields will be accepted but not saved. If false, requests with extra fields will be rejected.

Body

application/json

Response

200
application/json

Status 200 response

The response is of type object.