Direct Messages

Create or find chat

Idempotently creates a chat for a (profile, participant_external_id) pair. If a chat with that participant already exists, the existing chat is returned and any provided participant fields are updated.

Billing: Engagement action (request) · Rate limit: 60/min

post/v1/social/profiles/{profile_id}/chats

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/social/profiles/{profile_id}/chats
  • Auth: HTTP bearer

Path parameters

profile_idstring required

Profile ID

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

participant_namestring

Display name for the participant

participant_usernamestring

Display username for the participant

participant_external_idstring required

Platform participant ID (Instagram-scoped user ID for IG, PSID for Facebook, DID for Bluesky)

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.