Patch Resource - Reach Marketing & Automation Documentation

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": {}
      }
    ]
  }
}

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

data

object

required

Show child attributes

data.{key}

unknown

Response

Status 200 response

success

boolean

required

message

string

data

object

Show child attributes

data.result

object

required

Show child attributes

data.result.id

string<uuid>

required

Unique identifier for the resource

data.result.schema_definition_id

string<uuid>

required

[Deprecated] Please use schemaDefinitionId instead. ID of the schema definition for this resource

data.result.schemaDefinitionId

string<uuid>

required

ID of the schema definition for this resource

data.result.platform_id

string<uuid>

required

[Deprecated] Please use platformId instead. ID of the platform this resource belongs to

data.result.platformId

string<uuid>

required

ID of the platform this resource belongs to

data.result.business_id

string<uuid>

required

[Deprecated] Please use businessId instead. ID of the business this resource belongs to

data.result.businessId

string<uuid>

required

ID of the business this resource belongs to

data.result.resource_external_id

string

required

External ID of the resource

data.result.resourceExternalId

string

required

[Deprecated] Please use resourceExternalId instead. External ID of the resource

data.result.created_at

string

required

[Deprecated] Please use createdAt instead

data.result.createdAt

string

required

Creation timestamp

data.result.updated_at

string

required

[Deprecated] Please use updatedAt instead

data.result.updatedAt

string

required

Last update timestamp

data.result.data

object

required

The resource data matching the schema definition structure

Show child attributes

data.result.data.{key}

unknown

data.included

object[]

Included resources when specified in the include parameter

Show child attributes

data.included.id

string<uuid>

required

Unique identifier for the resource

data.included.schema_definition_id

string<uuid>

required

[Deprecated] Please use schemaDefinitionId instead. ID of the schema definition for this resource

data.included.schemaDefinitionId

string<uuid>

required

ID of the schema definition for this resource

data.included.platform_id

string<uuid>

required

[Deprecated] Please use platformId instead. ID of the platform this resource belongs to

data.included.platformId

string<uuid>

required

ID of the platform this resource belongs to

data.included.business_id

string<uuid>

required

[Deprecated] Please use businessId instead. ID of the business this resource belongs to

data.included.businessId

string<uuid>

required

ID of the business this resource belongs to

data.included.resource_external_id

string

required

External ID of the resource

data.included.resourceExternalId

string

required

[Deprecated] Please use resourceExternalId instead. External ID of the resource

data.included.created_at

string

required

[Deprecated] Please use createdAt instead

data.included.createdAt

string

required

Creation timestamp

data.included.updated_at

string

required

[Deprecated] Please use updatedAt instead

data.included.updatedAt

string

required

Last update timestamp

data.included.data

object

required

The resource data matching the schema definition structure

Show child attributes

data.included.data.{key}

unknown

Batch Patch Resources Upload Resource

⌘I

API Documentation

Headers

Path Parameters

Query Parameters

Body

Response