object Profile-About-Settings-Profile
{
  "type": "object",
  "title": "Root Type for About-XXX",
  "example": {
    "about": {
      "text": "your-profile-about-text"
    }
  },
  "properties": {
    "about": {
      "$ref": "#/components/schemas/Profile-About"
    }
  },
  "description": ""
}
object Profile-Photo-Settings
{
  "type": "object",
  "title": "Root Type for Profile-Photo-Settings",
  "example": {
    "profile": {
      "photo": {
        "link": "profile-photo-url"
      }
    }
  },
  "properties": {
    "profile": {
      "type": "object",
      "properties": {
        "photo": {
          "type": "object",
          "properties": {
            "link": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "description": ""
}
object Profile-Photo-Settings-Profile
{
  "type": "object",
  "title": "Root Type for Profile-Photo-Settings-Profile",
  "example": {
    "photo": {
      "link": "profile-photo-url"
    }
  },
  "properties": {
    "photo": {
      "$ref": "#/components/schemas/Profile-Photo-Settings-Profile-Photo"
    }
  },
  "description": ""
}
object Profile-Photo-Settings-Profile-Photo
{
  "type": "object",
  "title": "Root Type for Profile-Photo-Settings-Profile-Photo",
  "example": {
    "link": "profile-photo-url"
  },
  "properties": {
    "link": {
      "type": "string"
    }
  },
  "description": ""
}
string ProfileGetPhotoResponse
{
  "type": "string",
  "format": "binary"
}
object ProfileUpdatePhotoRequest
{
  "type": "object",
  "required": [
    "File"
  ],
  "properties": {
    "File": {
      "type": "string",
      "format": "binary"
    }
  }
}
object Provider
{
  "type": "object",
  "title": "Provider",
  "example": {
    "name": "<Provider Name from Media Provider API, optional"
  },
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string"
    }
  }
}
object Register-Account-Request-Body
{
  "type": "object",
  "title": "Register-Account-Request",
  "example": {
    "code": "your-registration-code-received-by-sms-or-voice-call"
  },
  "required": [
    "code"
  ],
  "properties": {
    "code": {
      "type": "string"
    }
  }
}
object Remove-Group-Participant-Request-Body
{
  "type": "object",
  "title": "Remove-Group-Participant-Request",
  "example": {
    "wa_ids": [
      "{{Recipient-WA-ID}}"
    ]
  },
  "required": [
    "wa_ids"
  ],
  "properties": {
    "wa_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    }
  }
}
object Request-Code-Account
{
  "type": "object",
  "title": "Root Type for Request-Code-Account",
  "example": {
    "vname": "decoded-vname-from-cert"
  },
  "properties": {
    "vname": {
      "type": "string"
    }
  },
  "description": ""
}
object Request-Code-Request-Body
{
  "type": "object",
  "title": "Request-Code-Request",
  "example": {
    "cc": "<Country Code>",
    "pin": "<Two-Step Verification PIN",
    "cert": "<Valid Cert from Business Manager>",
    "method": "< sms | voice >",
    "phone_number": "<Phone Number>"
  },
  "required": [
    "cc",
    "phone_number",
    "method",
    "cert"
  ],
  "properties": {
    "cc": {
      "type": "string",
      "description": "Numerical country code for the phone number you are registering"
    },
    "pin": {
      "type": "string",
      "description": "Existing 6-digit PIN — This is only required when two-factor verification is enabled on this account."
    },
    "cert": {
      "type": "string",
      "description": "Base64-encoded Verified Name certificate"
    },
    "method": {
      "enum": [
        "sms",
        "voice"
      ],
      "type": "string",
      "description": "Method of receiving your registration code"
    },
    "phone_number": {
      "type": "string",
      "description": "Phone number you are registering, without the country code or plus symbol (+)"
    }
  }
}
object Request-Code-Response
{
  "type": "object",
  "title": "Root Type for Request-Code-Response",
  "example": {
    "account": [
      {
        "vname": "decoded-vname-from-cert"
      }
    ]
  },
  "properties": {
    "account": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Request-Code-Account"
      }
    }
  },
  "description": ""
}
object Response
{
  "type": "object",
  "title": "Response",
  "example": {
    "meta": {
      "version": "whatsapp-business-api-client-version",
      "api_status": "deprecated"
    },
    "errors": [
      {
        "code": 1234,
        "title": "error-code-title",
        "details": "optional-detailed-error-message"
      }
    ]
  },
  "properties": {
    "meta": {
      "$ref": "#/components/schemas/Meta"
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Error"
      },
      "description": "Only returned with a failed request. Contains an array of error objects that are present when there is an error. "
    }
  },
  "description": ""
}
object Restore-Settings-Request-Body
{
  "type": "object",
  "title": "Restore-Settings-Request",
  "example": {
    "data": "<Data to Restore, from Backup API>",
    "password": "<Password for Backup>"
  },
  "required": [
    "password",
    "data"
  ],
  "properties": {
    "data": {
      "type": "string",
      "description": "The data that was returned by the /v1/settings/backup API call"
    },
    "password": {
      "type": "string",
      "description": "The password you used in the /v1/settings/backup API call to encrypt the backup data"
    }
  }
}
object Send-Message-Request-Body
{
  "type": "object",
  "title": "Send-Text-Message-Request",
  "example": {
    "to": "{whatsapp-id}",
    "text": {
      "body": "your-text-message-content"
    },
    "type": "text",
    "preview_url": true,
    "recipient_type": "individual"
  },
  "required": [
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "When recipient_type is individual, this field is the WhatsApp ID (phone number) returned from contacts endpoint. When recipient_type is group, this field is the WhatsApp group ID."
    },
    "hsm": {
      "$ref": "#/components/schemas/Hsm"
    },
    "ttl": {
      "type": "object"
    },
    "text": {
      "$ref": "#/components/schemas/Text"
    },
    "type": {
      "$ref": "#/components/schemas/Message-Type"
    },
    "audio": {
      "$ref": "#/components/schemas/Audio"
    },
    "image": {
      "$ref": "#/components/schemas/Image"
    },
    "video": {
      "$ref": "#/components/schemas/Video"
    },
    "contacts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Contact"
      },
      "description": ""
    },
    "document": {
      "$ref": "#/components/schemas/Document"
    },
    "location": {
      "$ref": "#/components/schemas/Location"
    },
    "preview_url": {
      "type": "boolean",
      "description": "Specifying preview_url in the request is optional when not including a URL in your message.\nTo include a URL preview, set preview_url to true in the message body and make sure the URL begins with http:// or https://. For more information, see the Sending URLs in Text Messages section."
    },
    "recipient_type": {
      "enum": [
        "individual",
        "group"
      ],
      "type": "string",
      "default": "individual",
      "description": "Determines whether the recipient is an individual or a group\nSpecifying recipient_type in the request is optional when the value is individual.\nHowever, recipient_type is required when using group. If sending a text message to a group, see the Sending Group Messages documentation."
    }
  }
}
object Set-Shards-Request-Body
{
  "type": "object",
  "title": "Set-Shards-Request",
  "example": {
    "cc": "<Country Code>",
    "pin": "<Two-Step PIN>",
    "shards": 32,
    "phone_number": "<Phone Number>"
  },
  "required": [
    "cc",
    "phone_number",
    "shards",
    "pin"
  ],
  "properties": {
    "cc": {
      "type": "string"
    },
    "pin": {
      "type": "string"
    },
    "shards": {
      "enum": [
        "1",
        "2",
        "4",
        "8",
        "16",
        "32"
      ],
      "type": "string",
      "format": "int32"
    },
    "phone_number": {
      "type": "string"
    }
  }
}
object Text
{
  "type": "object",
  "title": "Text",
  "example": {
    "body": "<Message Text>"
  },
  "required": [
    "body"
  ],
  "properties": {
    "body": {
      "type": "string"
    }
  }
}
object Update-Group-Info-Request-Body
{
  "type": "object",
  "title": "Update-Group-Info-Request",
  "example": {
    "subject": "<New Group Subject>"
  },
  "required": [
    "subject"
  ],
  "properties": {
    "subject": {
      "type": "string"
    }
  }
}
object Update-User-Request-Body
{
  "type": "object",
  "title": "Update-User-Request",
  "example": {
    "password": "New Password"
  },
  "required": [
    "password"
  ],
  "properties": {
    "password": {
      "type": "string",
      "description": "password"
    }
  }
}
object Upload-Media
{
  "type": "object",
  "title": "Root Type for Upload-Media",
  "example": {
    "id": "f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68"
  },
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "description": ""
}
object Upload-Media-Response
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response"
    },
    {
      "type": "object",
      "properties": {
        "media": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Upload-Media"
          }
        }
      }
    }
  ],
  "title": "Root Type for Upload-Media-Response",
  "example": {
    "media": [
      {
        "id": "f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68X"
      }
    ]
  },
  "description": ""
}
object Url
{
  "type": "object",
  "title": "Root Type for Url",
  "example": {
    "url": "https://www.facebook.com",
    "type": "WORK"
  },
  "properties": {
    "url": {
      "type": "string",
      "description": "URL"
    },
    "type": {
      "type": "string",
      "description": "Standard Values: HOME, WORK"
    }
  },
  "description": "Standard Values: HOME, WORK"
}
object User-Login-Response
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response"
    },
    {
      "type": "object",
      "properties": {
        "users": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/User-Login-Response-Item"
          }
        }
      }
    }
  ],
  "title": "UserLoginResponse",
  "example": {
    "users": [
      {
        "token": "eyJhbGciOHlXVCJ9.eyJ1c2VyIjoNTIzMDE2Nn0.mEoF0COaO00Z1cANo",
        "expires_after": "2018-03-01T15:29:26.000Z"
      }
    ]
  },
  "description": ""
}
object User-Login-Response-Item
{
  "type": "object",
  "title": "UserLoginResponseItem",
  "example": {
    "token": "eyJhbGciOHlXVCJ9.eyJ1c2VyIjoNTIzMDE2Nn0.mEoF0COaO00Z1cANo",
    "expires_after": "2018-03-01T15:29:26.000Z"
  },
  "properties": {
    "token": {
      "type": "string",
      "description": "Authentication token to be used for all other WhatsApp Business API calls. The token must be sent in the authorization header in the format:\nAuthorization: Bearer <authentication-token>"
    },
    "expires_after": {
      "type": "string",
      "format": "date-time",
      "description": "Token expiration timestamp. By default, this is 7 days."
    }
  },
  "description": ""
}
object User-Response
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response"
    },
    {
      "type": "object",
      "properties": {
        "users": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/User-Response-Item"
          }
        }
      }
    }
  ],
  "title": "Root Type for User-Create-Response",
  "example": {
    "users": [
      {
        "username": "username"
      }
    ]
  },
  "description": ""
}
object User-Response-Item
{
  "type": "object",
  "title": "Root Type for User-Create-Response-Item",
  "example": {
    "username": "username"
  },
  "properties": {
    "username": {
      "type": "string"
    }
  },
  "description": ""
}
string User-Role
{
  "enum": [
    "ROLE_ADMIN",
    "ROLE_USER"
  ],
  "type": "string",
  "description": ""
}
object Video
{
  "type": "object",
  "oneOf": [
    {
      "$ref": "#/components/schemas/VideoById"
    },
    {
      "$ref": "#/components/schemas/VideoByProvider"
    }
  ],
  "title": "Video",
  "description": "The media object containing a video"
}
object VideoById
{
  "type": "object",
  "title": "VideoById",
  "example": {
    "id": "<Media Id, from Media API>X",
    "caption": "<Message Caption>"
  },
  "required": [
    "caption",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "caption": {
      "type": "string"
    }
  }
}
object VideoByProvider
{
  "type": "object",
  "title": "ByProvider",
  "example": {
    "link": "<Link to Video, https>",
    "caption": "<Message Caption>",
    "provider": {
      "name": "<Provider Name from Media Provider API, optional"
    }
  },
  "required": [
    "provider",
    "caption",
    "link"
  ],
  "properties": {
    "link": {
      "type": "string"
    },
    "caption": {
      "type": "string"
    },
    "provider": {
      "$ref": "#/components/schemas/Provider"
    }
  }
}
object Webhook-Audio
{
  "type": "object",
  "title": "Root Type for Webhook-Audio",
  "example": {
    "id": "media-id",
    "file": "absolute-filepath-on-coreapp",
    "link": "link-to-audio-file",
    "sha256": "checksum",
    "mime_type": "media-mime-type"
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the media. Can be used to delete the media if stored locally on the client."
    },
    "file": {
      "type": "string",
      "deprecated": true,
      "description": "Absolute filename and location on media volume. This parameter is deprecated."
    },
    "link": {
      "type": "string"
    },
    "sha256": {
      "type": "string",
      "description": "Checksum"
    },
    "caption": {
      "type": "string",
      "description": "Optional. Only present if specified."
    },
    "filename": {
      "type": "string",
      "description": "Filename on the sender's device. This will only be present in audio and document media messages."
    },
    "mime_type": {
      "type": "string",
      "description": "Mime type of media"
    }
  },
  "description": ""
}
object Webhook-Contact
{
  "type": "object",
  "title": "Root Type for Webhook-Contact",
  "example": {
    "wa_id": "16315551234",
    "profile": {
      "name": "Kerry Fisher"
    }
  },
  "properties": {
    "wa_id": {
      "type": "string",
      "description": "The WhatsApp ID of the contact"
    },
    "profile": {
      "$ref": "#/components/schemas/Webhook-Contact-Profile"
    }
  },
  "description": ""
}
object Webhook-Contact-Profile
{
  "type": "object",
  "title": "Root Type for Webhook-Contact-Profile",
  "example": {
    "name": "sender-profile-name"
  },
  "properties": {
    "name": {
      "type": "string",
      "description": "Optional. As of v2.21.4, contains the sender's profile name."
    }
  },
  "description": ""
}
object Webhook-Document
{
  "type": "object",
  "title": "Root Type for Webhook-Document",
  "example": {
    "id": "fc233119-733f-49c-bcbd-b2f68f798e33",
    "file": "/usr/local/wamedia/shared/fc233119-733f-49c-bcbd-b2f68f798e33",
    "sha256": "3b11fa6ef2bde1dd14726e09d3edaf782120919d06f6484f32d5d5caa4b8e",
    "caption": "80skaraokesonglistartist",
    "mime_type": "application/pdf"
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the media. Can be used to delete the media if stored locally on the client."
    },
    "file": {
      "type": "string",
      "deprecated": true,
      "description": "Absolute filename and location on media volume. This parameter is deprecated."
    },
    "link": {
      "type": "string"
    },
    "sha256": {
      "type": "string",
      "description": "Checksum"
    },
    "caption": {
      "type": "string",
      "description": "Optional. Only present if specified."
    },
    "filename": {
      "type": "string",
      "description": "Filename on the sender's device. This will only be present in audio and document media messages."
    },
    "mime_type": {
      "type": "string",
      "description": "Mime type of media"
    }
  },
  "description": ""
}
object Webhook-Event
{
  "type": "object",
  "title": "Root Type for Webhook-Event",
  "example": {
    "contacts": [
      {
        "wa_id": "16315551234",
        "profile": {
          "name": "Kerry Fisher"
        }
      }
    ],
    "messages": [
      {
        "id": "ABGGFlA5FpafAgo6tHcNmNjXmuSf",
        "from": "16315551234",
        "text": {
          "body": "Hello this is an answer"
        },
        "type": "text",
        "timestamp": "1518694235"
      }
    ]
  },
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Error"
      }
    },
    "contacts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Webhook-Contact"
      }
    },
    "messages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Webhook-Message"
      }
    },
    "statuses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Webhook-Status"
      }
    }
  },
  "description": ""
}
object Webhook-Image
{
  "type": "object",
  "title": "Root Type for Webhook-Image",
  "example": {
    "id": "b1c68f38-8734-4ad3-b4a1-ef0c10d683",
    "file": "/usr/local/wamedia/shared/b1cf38-8734-4ad3-b4a1-ef0c10d0d683",
    "sha256": "29ed500fa64eb55fc19dc4124acb300e5dcc54a0f822a301ae99944db",
    "caption": "Check out my new phone!",
    "mime_type": "image/jpeg"
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the media. Can be used to delete the media if stored locally on the client."
    },
    "file": {
      "type": "string",
      "deprecated": true,
      "description": "Absolute filename and location on media volume. This parameter is deprecated."
    },
    "link": {
      "type": "string"
    },
    "sha256": {
      "type": "string",
      "description": "Checksum"
    },
    "caption": {
      "type": "string",
      "description": "Optional. Only present if specified."
    },
    "mime_type": {
      "type": "string",
      "description": "Mime type of media"
    }
  },
  "description": ""
}
object Webhook-Location
{
  "type": "object",
  "title": "Root Type for Webhook-Location",
  "example": {
    "url": "https://foursquare.com/v/4d7031d35b5df7744",
    "name": "Main Street Beach",
    "address": "Main Street Beach, Santa Cruz, CA",
    "latitude": 38.9806263495,
    "longitude": -131.9428612257
  },
  "properties": {
    "url": {
      "type": "string",
      "description": "URL for the website where the user downloaded the location information"
    },
    "name": {
      "type": "string",
      "description": "Name of the location"
    },
    "address": {
      "type": "string",
      "description": "Address of the location"
    },
    "latitude": {
      "type": "number",
      "format": "double",
      "description": "Latitude of location being sent"
    },
    "longitude": {
      "type": "number",
      "format": "double",
      "description": "Longitude of location being sent"
    }
  },
  "description": ""
}
object Webhook-Message
{
  "type": "object",
  "title": "Root Type for Webhook-Message",
  "example": {
    "id": "ABGGFlA5FpafAgo6tHcNmNjXmuSfX",
    "from": "16315551234",
    "text": {
      "body": "Hello this is an answer"
    },
    "type": "text",
    "timestamp": "1518694235"
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "Message ID"
    },
    "from": {
      "type": "string",
      "description": "WhatsApp ID of the sender"
    },
    "text": {
      "$ref": "#/components/schemas/Webhook-Text"
    },
    "type": {
      "$ref": "#/components/schemas/Message-Type"
    },
    "audio": {
      "$ref": "#/components/schemas/Webhook-Audio"
    },
    "image": {
      "$ref": "#/components/schemas/Webhook-Image"
    },
    "video": {
      "$ref": "#/components/schemas/Webhook-Video"
    },
    "voice": {
      "$ref": "#/components/schemas/Webhook-Voice"
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Error"
      }
    },
    "system": {
      "$ref": "#/components/schemas/Webhook-System"
    },
    "context": {
      "$ref": "#/components/schemas/Message-Context"
    },
    "contacts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Contact"
      }
    },
    "document": {
      "$ref": "#/components/schemas/Webhook-Document"
    },
    "group_id": {
      "type": "string",
      "description": "Optional. WhatsApp group ID"
    },
    "location": {
      "$ref": "#/components/schemas/Webhook-Location"
    },
    "timestamp": {
      "type": "string",
      "description": "Message received timestamp"
    }
  },
  "description": ""
}
object Webhook-Status
{
  "type": "object",
  "title": "Root Type for Webhook-Status",
  "example": {
    "id": "gBGGEgZHMlEfAgkM1RBkhDRr7t8",
    "errors": [
      {
        "code": 470,
        "title": "Failed to send message because you are outside the support window for freeform messages to this user. Please use a valid HSM notification or reconsider."
      }
    ],
    "status": "failed",
    "timestamp": "1533332775",
    "recipient_id": "12064001000"
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "Message ID"
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Error"
      }
    },
    "status": {
      "enum": [
        "sent",
        "delivered",
        "read",
        "failed",
        "deleted"
      ],
      "type": "string",
      "description": "Status of message",
      "x-enum-descriptions": [
        "Message received by WhatsApp server (One checkmark in WhatsApp Mobile)",
        "Message delivered to recipient (Two checkmarks in WhatsApp Mobile)",
        "Message read by recipient (Two blue checkmarks in WhatsApp Mobile)",
        "Message failed to send (Red error triangle in WhatsApp Mobile)",
        "Message deleted by the user"
      ]
    },
    "timestamp": {
      "type": "string",
      "description": "Timestamp of the status message"
    },
    "recipient_id": {
      "type": "string",
      "description": "WhatsApp ID of recipient"
    }
  },
  "description": ""
}
object Webhook-System
{
  "type": "object",
  "title": "Root Type for Webhook-System",
  "example": {
    "body": "+1 (650) 387-5246 added +1 (650) 644-8470",
    "type": "group_user_joined",
    "users": [
      "16506448470"
    ],
    "group_id": "16315558032-1530825318",
    "operator": "16503875246"
  },
  "properties": {
    "body": {
      "type": "string"
    },
    "type": {
      "enum": [
        "group_created",
        "group_user_promoted",
        "group_user_demoted",
        "group_user_joined",
        "group_user_left",
        "group_subject_changed",
        "group_description_changed",
        "group_icon_changed",
        "group_icon_deleted",
        "group_invite_link_revoked",
        "user_identity_changed",
        "group_user_changed_number",
        "group_error_fetching_photo",
        "group_error_adding_users",
        "group_error_adding_user",
        "group_error_full_adding_users",
        "group_error_removing_user",
        "broadcast_list_created",
        "group_ended",
        "group_error_blocked_adding_user"
      ],
      "type": "string",
      "description": "",
      "x-enum-descriptions": [
        "Group created",
        "Group user promoted to admin",
        "Group user removed as admin",
        "User joined the group",
        "User left the group",
        "Group subject changed",
        "Group description changed",
        "Group icon changed",
        "Group icon deleted",
        "Group's invite link disabled",
        "User's end-to-end keys changed",
        "User's phone number changed",
        "Error retrieving the group photo",
        "Error adding users to the group",
        "Error adding a user to the group",
        "Group is at capacity and no more users can be added",
        "Error removing user from group",
        "Broadcast list created",
        "Group ended",
        "Error attempting to add a user that blocked the adder"
      ]
    }
  },
  "description": ""
}
object Webhook-Text
{
  "type": "object",
  "title": "Root Type for Webhook-Text",
  "example": {
    "body": "text-message-content"
  },
  "properties": {
    "body": {
      "type": "string",
      "description": "Message text"
    }
  },
  "description": ""
}
object Webhook-Video
{
  "type": "object",
  "title": "Root Type for Webhook-Video",
  "example": {
    "id": "media-idX",
    "file": "absolute-filepath-on-coreapp",
    "link": "link-to-video-file",
    "sha256": "checksum",
    "mime_type": "media-mime-type"
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the media. Can be used to delete the media if stored locally on the client."
    },
    "file": {
      "type": "string",
      "deprecated": true,
      "description": "Absolute filename and location on media volume. This parameter is deprecated."
    },
    "link": {
      "type": "string"
    },
    "sha256": {
      "type": "string",
      "description": "Checksum"
    },
    "caption": {
      "type": "string",
      "description": "Optional. Only present if specified."
    },
    "mime_type": {
      "type": "string",
      "description": "Mime type of media"
    }
  },
  "description": ""
}
object Webhook-Voice
{
  "type": "object",
  "title": "Root Type for Webhook-Voice",
  "example": {
    "id": "463eb7ec-ff4e-4d9b-b110-1879cbd411b2",
    "file": "/usr/local/wamedia/shared/463e/b7ec/ff4e4d9bb1101879cbd411b2",
    "sha256": "fa9e1807d936b7cebe63654ea3a7912b1fa9479220258d823590521ef53b0710",
    "mime_type": "audio/ogg; codecs=opus"
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the media. Can be used to delete the media if stored locally on the client."
    },
    "file": {
      "type": "string",
      "deprecated": true,
      "description": "Absolute filename and location on media volume. This parameter is deprecated."
    },
    "link": {
      "type": "string"
    },
    "sha256": {
      "type": "string",
      "description": "Checksum"
    },
    "caption": {
      "type": "string",
      "description": "Optional. Only present if specified."
    },
    "mime_type": {
      "type": "string",
      "description": "Mime type of media"
    }
  },
  "description": ""
}
object Webhooks
{
  "type": "object",
  "title": "Webhooks",
  "example": {
    "url": "<Webhook URL, https>",
    "max_concurrent_requests": 12
  },
  "properties": {
    "url": {
      "type": "string",
      "description": "Inbound and outbound notifications are routed to this URL. A HTTPS-based endpoint is required; HTTP will not work."
    },
    "max_concurrent_requests": {
      "enum": [
        "6",
        "12",
        "18",
        "24"
      ],
      "type": "string",
      "format": "int32",
      "default": 6,
      "description": "Configures the maximum number of inflight callback requests that are sent out. Can be set to 6 (default), 12, 18, or 24."
    }
  }
}