Create Faq - YCloud Docs

{
  "id": "<string>",
  "question": "<string>",
  "answer": "<string>",
  "created_at": 123,
  "metadata": {}
}

{
  "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}

/

faqs

{
  "id": "<string>",
  "question": "<string>",
  "answer": "<string>",
  "created_at": 123,
  "metadata": {}
}

{
  "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

question

string

required

Minimum string length: 1

answer

string

required

Minimum string length: 1

metadata

object

Show child attributes

Response

Operation completed successfully.

id

string

FAQ resource ID.

question

string

Customer question written in natural language.

answer

string

Factual answer the agent should use.

created_at

integer<int64>

Meta creation timestamp.

metadata

object

String metadata retained with the FAQ.

Show child attributes