Targets

Update target metadata

Shallow-merge key-value pairs into the target's metadata object.

Existing keys are preserved unless explicitly overwritten. Useful for syncing CRM IDs, flags, or any custom data.

Example: { "synced_to_hubspot": true, "hubspot_id": "HS-98765" }

patch/api/v1/targets/{id}/metadata

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/targets/{id}/metadata
  • Auth: bearerAuth (a scheme the document does not define)

Path parameters

idstring uuid required

Resource UUID

Request body

metadataobject required

Key-value pairs to merge into the target metadata. Existing keys are preserved unless overwritten.

Example request

{
  "metadata": {
    "synced_to_hubspot": true,
    "hubspot_id": "HS-98765"
  }
}

Response

Updated

successtrue required
messagestring

Example response

{
  "data": {
    "name": "John Doe",
    "phone": "+525512345678"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.