Control Thread - YCloud Docs

{
  "messaging_product": "<string>"
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

POST

https://api.ycloud.com/v2

/

metaBusinessAgents

/

{entityId}

/

threadControl

{
  "messaging_product": "<string>"
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "target": "<string>",
  "docUrl": "<string>",
  "requestId": "<string>",
  "metaBusinessAgentApiError": {
    "title": "<string>",
    "detail": "<string>",
    "type": "<string>",
    "status": 123,
    "requestId": "<string>"
  }
}

Authorizations

X-API-Key

string

header

required

Path Parameters

entityId

string

required

WhatsApp Business Phone Number ID that owns the Meta Business Agent.

Body

application/json

action

enum<string>

required

Available options:

pass,

release,

take

to

string

Consumer identifier: a phone number in E.164 format or a WhatsApp ID.

recipient

string

Business-scoped user ID. Meta currently recommends providing to instead.

metadata

string

Optional context for the thread-control transition.

Maximum string length: 2000

Response

Operation completed successfully.

messaging_product

string

Messaging product confirmed by Meta.