These endpoints are available only when Murph is enabled for the caller’s
customer account.
Bind a conversation
POST /api/v2/murph/chat
The first message of a conversation accepts an optional scope binding. Omit it —
or send scopeType: "customer" — for an account-scoped conversation. Send
scopeType: "advertiser" with the advertiser’s id in scopeId to bind the
conversation to one advertiser.
curl
Request fields
| Field | Type | Required | Notes |
|---|---|---|---|
scopeType | "customer" | "advertiser" | No | Scope to bind the new conversation to. Defaults to customer when omitted. |
scopeId | string | No | The advertiser id when scopeType is advertiser. Max 120 characters. Not used for customer scope. |
scopeType/scopeId on a
later turn of an existing conversation has no effect; the stored binding always
wins. To work in a different scope, start a new conversation.
Read the binding
GET /api/v2/murph/conversations
Every conversation summary carries its scope binding, so you can group or filter
conversations by the account or advertiser they belong to. The
single-conversation endpoint, GET /api/v2/murph/conversations/{conversationUid},
returns the same fields.
Response (excerpt)
| Field | Type | Notes |
|---|---|---|
scopeType | "customer" | "advertiser" | The scope the conversation is bound to. Always present. |
scopeId | string | null | The bound advertiser id when scopeType is advertiser; null for account scope. |
Scope and access
Scope binding is contextual: it organizes your conversations and frames Murph’s responses around the chosen node. It does not change what a conversation can access. Every Murph conversation is bound by thecustomer_id of the
authenticated caller, and that account remains the access boundary regardless of
the conversation’s scope — binding to an advertiser narrows the conversation’s
focus, not its permissions.
Errors
400 VALIDATION_ERROR—scopeTypeis notcustomeroradvertiser, orscopeIdexceeds 120 characters.401 UNAUTHORIZED— missing or invalid bearer token.403 FORBIDDEN— Murph is not enabled for the caller’s account.
Related
Ask Murph
How Murph works as the in-product assistant.
Murph user preferences
Set Murph’s default language and read display preferences.