ComRaidComRaid Docs

Contacts

Contacts are end recipients identified by your product’s external_user_id.

Create contact

POST https://api.comraid.io/contacts
Authorization: Bearer cr_sk_...
Content-Type: application/json

{
  "external_user_id": "user_123",
  "name": "Jane Doe",
  "locale": "en-US",
  "timezone": "America/New_York",
  "attributes": {
    "plan": "premium",
    "plan_tier": "gold",
    "favorite_category": "electronics"
  },
  "metadata": {
    "debug_note": "optional opaque JSON"
  }
}

Upsert contact

Prefer PUT whenever profile or audience state changes. Safe to call repeatedly from your product backend. Include attributes in the same request — no separate attributes call required.

PUT https://api.comraid.io/contacts/{external_user_id}
Authorization: Bearer cr_sk_...
Content-Type: application/json

{
  "name": "Jane Doe",
  "locale": "en-US",
  "timezone": "America/New_York",
  "attributes": {
    "plan": "silver",
    "plan_tier": "gold",
    "favorite_category": "electronics"
  }
}
  • external_user_id is your stable user identifier within the Project (path param on PUT).
  • attributes are free-form messaging audience key/value pairs used for Segments. Omitted keys are left unchanged. See Contact attributes.
  • metadata is opaque product JSON for debugging — not used for segmentation.

Request and response schemas are in the API Reference.

On this page