PostCreatecontactactivitiesRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bounceexchange/main/json-schema/bounceexchange-post-createcontactactivities-request-schema.json",
  "title": "PostCreatecontactactivitiesRequest",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/bounceexchange-openapi-generated.yml#/components/schemas/PostCreatecontactactivitiesRequest",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "description": "Identifier for the source system, e.g., \"wk-esp\"."
    },
    "contact": {
      "type": "object",
      "description": "Contact identification and attribute data."
    },
    "contact.identifiers.email": {
      "type": "string",
      "description": "Email address used to identify the contact."
    },
    "contact.identifiersPriority": {
      "type": "array",
      "description": "Priority list of identifier fields; email is the sole entry."
    },
    "contact.attributes.channels.email.address": {
      "type": "string",
      "description": "Email address channel attribute."
    },
    "contact.attributes.wk_identified": {
      "type": "boolean",
      "description": "Flag set to true when a new contact is created."
    },
    "contact.canBeCreated": {
      "type": "boolean",
      "description": "Allows Cordial to create the contact if it does not exist."
    },
    "contact.canBeUpdated": {
      "type": "boolean",
      "description": "Prevents updates to an existing contact."
    },
    "contact.forceSubscribe": {
      "type": "boolean",
      "description": "If true, newly identified contacts are subscribed on the email channel."
    },
    "contactActivities": {
      "type": "array",
      "description": "Array of activity objects, each representing a Custom Event."
    },
    "contactActivities[].name": {
      "type": "string",
      "description": "Custom Event name (e.g., \"wknd-email-prodabandonment\")."
    },
    "contactActivities[].time": {
      "type": "string",
      "description": "ISO‑8601 timestamp for the event."
    },
    "contactActivities[].properties": {
      "type": "object",
      "description": "Payload of event‑specific properties (varies by campaign strategy)."
    }
  },
  "required": [
    "source",
    "contact",
    "contact.identifiers.email",
    "contact.identifiersPriority",
    "contact.attributes.channels.email.address",
    "contact.attributes.wk_identified",
    "contact.canBeCreated",
    "contact.canBeUpdated",
    "contactActivities",
    "contactActivities[].name",
    "contactActivities[].time",
    "contactActivities[].properties"
  ]
}