object Group-Response

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response"
    },
    {
      "type": "object",
      "properties": {
        "groups": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Group-Info"
          }
        }
      }
    }
  ],
  "title": "Group-Response",
  "example": {
    "groups": [
      {
        "admins": [
          "whatsapp-id-1",
          "whatsapp-id-2"
        ],
        "creator": "whatsapp-id-1",
        "subject": "your-group-subject",
        "participants": [
          "whatsapp-id-3",
          "whatsapp-id-4",
          "whatsapp-id-5"
        ],
        "creation_time": 123456789
      }
    ]
  },
  "description": ""
}

object Groups-Response

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response"
    },
    {
      "type": "object",
      "properties": {
        "groups": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Group"
          }
        }
      }
    }
  ],
  "title": "GroupsResponse",
  "example": {
    "groups": [
      {
        "id": "your-group-idX",
        "creation_time": 123456789
      }
    ]
  },
  "description": ""
}

object GroupsDeleteGroupIconRequest

{
  "type": "object",
  "required": [
    "File"
  ],
  "properties": {
    "File": {
      "type": "string",
      "format": "binary"
    }
  }
}

object GroupsSetGroupIconRequest

{
  "type": "object",
  "required": [
    "File"
  ],
  "properties": {
    "File": {
      "type": "string",
      "format": "binary"
    }
  }
}

string HealthGetAppStats200Response

{
  "type": "string"
}

object HealthGetAppStatsResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

string HealthGetDbStats200Response

{
  "type": "string"
}

object HealthGetDbStatsResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

string HealthGetMetricsData200Response

{
  "type": "string"
}

object HealthGetMetricsDataResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object HealthGetSupportInfoResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object Hsm

{
  "type": "object",
  "title": "Hsm",
  "example": {
    "language": {
      "code": "en",
      "policy": "deterministic"
    },
    "namespace": "business_a_namespace",
    "element_name": "hello_world",
    "localizable_params": [
      {
        "default": "1234"
      }
    ]
  },
  "required": [
    "namespace",
    "element_name",
    "language",
    "localizable_params"
  ],
  "properties": {
    "language": {
      "$ref": "#/components/schemas/Language"
    },
    "namespace": {
      "type": "string",
      "description": "The namespace that will be used"
    },
    "element_name": {
      "type": "string",
      "description": "The element name that indicates which template to use within the namespace"
    },
    "localizable_params": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LocalizableParam"
      },
      "description": "This field is an array of values to apply to variables in the template"
    }
  },
  "description": "The containing element for the message content — Indicates that the message is highly structured. Parameters contained within provide the structure."
}

object Image

{
  "type": "object",
  "oneOf": [
    {
      "$ref": "#/components/schemas/ImageById"
    },
    {
      "$ref": "#/components/schemas/ImageByProvider"
    }
  ],
  "title": "Image",
  "description": "The media object containing an image"
}

object ImageById

{
  "type": "object",
  "title": "ImageById",
  "example": {
    "id": "<Media Id, from Media API>X",
    "caption": "<Message Caption>"
  },
  "required": [
    "caption",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "caption": {
      "type": "string"
    }
  }
}

object ImageByProvider

{
  "type": "object",
  "title": "ImageByProvider",
  "example": {
    "link": "<Link to Image, https>",
    "caption": "<Media Caption>",
    "provider": {
      "name": "<Provider Name from Media Provider API, optional"
    }
  },
  "required": [
    "provider",
    "link",
    "caption"
  ],
  "properties": {
    "link": {
      "type": "string"
    },
    "caption": {
      "type": "string"
    },
    "provider": {
      "$ref": "#/components/schemas/Provider"
    }
  }
}

object Language

{
  "type": "object",
  "title": "Language",
  "example": {
    "code": "en",
    "policy": "deterministic"
  },
  "required": [
    "policy",
    "code"
  ],
  "properties": {
    "code": {
      "type": "string",
      "description": "The code of the language or locale to use — Accepts both language and language_locale formats (e.g., en and en_US)."
    },
    "policy": {
      "enum": [
        "fallback",
        "deterministic"
      ],
      "type": "string",
      "description": "The language policy the message should follow"
    }
  }
}

object LocalizableParam

{
  "type": "object",
  "title": "LocalizableParam",
  "example": {
    "default": "<param value>"
  },
  "required": [
    "default"
  ],
  "properties": {
    "default": {
      "type": "string",
      "description": "Default text if localization fails"
    },
    "currency": {
      "$ref": "#/components/schemas/Currency"
    },
    "date_time": {
      "$ref": "#/components/schemas/Date-Time-Object"
    }
  }
}

object Location

{
  "type": "object",
  "title": "Location",
  "example": {
    "name": "<Location Name>",
    "address": "<Location's Address>",
    "latitude": "<Latitude>",
    "longitude": "<Longitude>"
  },
  "required": [
    "longitude",
    "latitude",
    "name",
    "address"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the location"
    },
    "address": {
      "type": "string",
      "description": "Address of the location. Only displayed if name is present."
    },
    "latitude": {
      "type": "string",
      "description": "Latitude of the location"
    },
    "longitude": {
      "type": "string",
      "description": "Longitude of the location"
    }
  }
}

object Login-Admin-Request-Body

{
  "type": "object",
  "title": "Login-Admin-Request",
  "example": {
    "new_password": "<New Admin Password>"
  },
  "required": [
    "new_password"
  ],
  "properties": {
    "new_password": {
      "type": "string"
    }
  }
}

object Mark-Message-As-Read-Request-Body

{
  "type": "object",
  "title": "Mark-Message-As-Read-Request",
  "example": {
    "status": "read"
  },
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "type": "string",
      "default": "read"
    }
  }
}

object Media

{
  "type": "object",
  "title": "Media",
  "example": {
    "auto_download": [
      "image",
      "document",
      "audio"
    ]
  },
  "required": [
    "auto_download"
  ],
  "properties": {
    "auto_download": {
      "type": "array",
      "items": {
        "enum": [
          "audio",
          "document",
          "voice",
          "video",
          "image."
        ],
        "type": "string"
      },
      "description": "An array specifying which types of media to automatically download."
    }
  }
}

object Media-Provider

{
  "type": "object",
  "title": "Update-Media-Providers-Request",
  "example": {
    "name": "<Provider Name>",
    "type": "www",
    "config": {
      "bearer": "<Bearer Auth Token>"
    }
  },
  "properties": {
    "name": {
      "type": "string",
      "description": "The name for the provider"
    },
    "type": {
      "type": "string",
      "description": "The type of provider"
    },
    "config": {
      "$ref": "#/components/schemas/Config"
    }
  }
}

object Media-Provider-Settings

{
  "type": "object",
  "title": "Root Type for Settings",
  "example": {
    "application": {
      "media": {
        "providers": [
          {
            "name": "your-first-provider",
            "type": "www",
            "config": {
              "basic": {
                "password": "your-password",
                "username": "your-username"
              }
            }
          },
          {
            "name": "your-second-provider",
            "type": "www",
            "config": {
              "bearer": "your-bearer-token"
            }
          }
        ]
      }
    }
  },
  "properties": {
    "application": {
      "$ref": "#/components/schemas/Media-Provider-Settings-Application"
    }
  },
  "description": ""
}

object Media-Provider-Settings-Application

{
  "type": "object",
  "title": "Root Type for Settings-Application",
  "example": {
    "media": {
      "providers": [
        {
          "name": "your-first-provider",
          "type": "www",
          "config": {
            "basic": {
              "password": "your-password",
              "username": "your-username"
            }
          }
        },
        {
          "name": "your-second-provider",
          "type": "www",
          "config": {
            "bearer": "your-bearer-token"
          }
        }
      ]
    }
  },
  "properties": {
    "media": {
      "$ref": "#/components/schemas/Media-Provider-Settings-Application-Media"
    }
  },
  "description": ""
}

object Media-Provider-Settings-Application-Media

{
  "type": "object",
  "title": "Root Type for Settings-Application-Media",
  "example": {
    "providers": [
      {
        "name": "your-first-provider",
        "type": "www",
        "config": {
          "basic": {
            "password": "your-password",
            "username": "your-username"
          }
        }
      },
      {
        "name": "your-second-provider",
        "type": "www",
        "config": {
          "bearer": "your-bearer-token"
        }
      }
    ]
  },
  "properties": {
    "providers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Media-Provider"
      }
    }
  },
  "description": ""
}

object MediaDownloadResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

string MediaUploadMediaRequest

{
  "type": "string",
  "format": "binary"
}

string MediaUploadMediaRequest1

{
  "type": "string",
  "format": "binary"
}

string MediaUploadMediaRequest10

{
  "type": "string",
  "format": "binary"
}

string MediaUploadMediaRequest11

{
  "type": "string",
  "format": "binary"
}

string MediaUploadMediaRequest12

{
  "type": "string",
  "format": "binary"
}

string MediaUploadMediaRequest13

{
  "type": "string",
  "format": "binary"
}

string MediaUploadMediaRequest2

{
  "type": "string",
  "format": "binary"
}

string MediaUploadMediaRequest3

{
  "type": "string",
  "format": "binary"
}

string MediaUploadMediaRequest4

{
  "type": "string",
  "format": "binary"
}

string MediaUploadMediaRequest5

{
  "type": "string",
  "format": "binary"
}

string MediaUploadMediaRequest6

{
  "type": "string",
  "format": "binary"
}

string MediaUploadMediaRequest7

{
  "type": "string",
  "format": "binary"
}

string MediaUploadMediaRequest8

{
  "type": "string",
  "format": "binary"
}

string MediaUploadMediaRequest9

{
  "type": "string",
  "format": "binary"
}

object Message

{
  "type": "object",
  "title": "Message",
  "example": {
    "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
  },
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "description": ""
}

object Message-Context

{
  "type": "object",
  "title": "Root Type for Message-Context",
  "example": {
    "id": "message-id-of-context-message",
    "from": "sender-wa-id-of-context-message",
    "group_id": "group-id-of-context-message",
    "mentions": [
      "wa-id1",
      "wa-id2"
    ]
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "message id"
    },
    "from": {
      "type": "string",
      "description": "Sender Whatsapp id of context-message"
    },
    "group_id": {
      "type": "string",
      "description": "GroupId of context message"
    },
    "mentions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Whats app ids"
    }
  },
  "description": ""
}

object Message-Response

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response"
    },
    {
      "type": "object",
      "properties": {
        "messages": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Message"
          }
        }
      }
    }
  ],
  "title": "Message-Response",
  "example": {
    "messages": [
      {
        "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrUX"
      }
    ]
  },
  "description": ""
}

string Message-Type

{
  "enum": [
    "audio",
    "contacts",
    "document",
    "hsm",
    "image",
    "location",
    "text",
    "video",
    "voice",
    "unknown"
  ],
  "type": "string",
  "default": "text",
  "description": "type of the message"
}

object Meta

{
  "type": "object",
  "title": "Meta",
  "example": {
    "version": "whatsapp-business-api-client-version",
    "api_status": "stable"
  },
  "properties": {
    "version": {
      "type": "string"
    },
    "api_status": {
      "enum": [
        "deprecated",
        "experimental",
        "stable"
      ],
      "type": "string"
    }
  },
  "description": "Contains generic information such as WhatsApp Business API Client version."
}

object Name

{
  "type": "object",
  "title": "Name",
  "example": {
    "last_name": "Smith",
    "first_name": "John",
    "formatted_name": "John Smith"
  },
  "required": [
    "formatted_name"
  ],
  "properties": {
    "prefix": {
      "type": "string",
      "description": "Name preffix"
    },
    "suffix": {
      "type": "string",
      "description": "Name suffix"
    },
    "last_name": {
      "type": "string",
      "description": "Last name"
    },
    "first_name": {
      "type": "string",
      "description": "First name"
    },
    "formatted_name": {
      "type": "string",
      "description": "Full name as it normally appears"
    }
  },
  "description": "Full contact name"
}

object Org

{
  "type": "object",
  "title": "Org",
  "example": {
    "title": "Manager",
    "company": "WhatsApp",
    "department": "Design"
  },
  "required": [
    "company"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "Contact's business title"
    },
    "company": {
      "type": "string",
      "description": "Name of the contact's company"
    },
    "department": {
      "type": "string",
      "description": "Name of the contact's department"
    }
  },
  "description": "Contact organization information"
}

object Phone

{
  "type": "object",
  "title": "Phone",
  "example": {
    "type": "WORK",
    "phone": "+1 (650) 555-1234",
    "wa_id": "16505551234"
  },
  "properties": {
    "type": {
      "type": "string",
      "description": "Standard Values: CELL, MAIN, IPHONE, HOME, WORK"
    },
    "phone": {
      "type": "string"
    },
    "wa_id": {
      "type": "string",
      "description": "WhatsApp ID"
    }
  }
}

object Profile-About

{
  "type": "object",
  "title": "Set-Profile-About-Request",
  "example": {
    "text": "<About Profile>"
  },
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "description": "Text to display in your profile's About section\nThe max length for the string is 139 characters."
    }
  }
}

object Profile-About-Settings

{
  "type": "object",
  "title": "Root Type for Profile-About-Settings",
  "example": {
    "profile": {
      "about": {
        "text": "your-profile-about-text"
      }
    }
  },
  "properties": {
    "profile": {
      "$ref": "#/components/schemas/Profile-About-Settings-Profile"
    }
  },
  "description": ""
}