id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
api_score
float64
0
10
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
fd91a2ba-6522-4931-9a14-133934b39992/729c4551-1c94-4cc8-a1ac-08981a08a987/1/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getMessages
500
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/729c4551-1c94-4cc8-a1ac-08981a08a987/2/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getMessages
200
null
{"messages": [{"id": "", "type": "text", "subtype": "", "chat_id": "", "from": "", "from_me": true, "from_name": "", "timestamp": 0, "status": "failed", "system": {}, "order": {}, "product_items": {}, "action": {}, "context": {}, "reactions": []}], "count": 0, "total": 0, "offset": 0}
{"title": "List of messages", "type": "object", "properties": {"messages": {"title": "Messages", "type": "array", "items": {"title": "Message", "required": ["id", "type", "chat_id", "from_me", "timestamp"], "type": "object", "properties": {"id": {"type": "string", "description": "Message ID"}, "type": {"default": "text", "type": "string", "description": "Message type", "enum": ["text", "image", "video", "gif", "audio", "voice", "document", "location", "live_location", "contact", "contact_list", "sticker", "system", "call", "unknown", "action", "group_invite", "product", "interactive", "reply", "poll", "hsm"]}, "subtype": {"type": "string", "description": "Message subtype"}, "chat_id": {"type": "string", "description": "Chat ID"}, "from": {"description": "WhatsApp ID of the sender", "type": "string"}, "from_me": {"type": "boolean", "description": "Is message from me"}, "from_name": {"type": "string", "description": "Pushname of the sender"}, "timestamp": {"type": "number", "description": "Message timestamp"}, "status": {"type": "string", "description": "Message ack status", "enum": ["failed", "pending", "sent", "delivered", "read", "played", "deleted"], "x-enum-descriptions": ["Message failed to send (Red error triangle in WhatsApp Mobile)", "Message pending to send (One clock in WhatsApp Mobile)", "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)", "Voice-message played by recipient (Two blue checkmarks in WhatsApp Mobile)", "Message deleted by the user"]}, "text": {"title": "Content text message", "description": "", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "image": {"title": "Content image message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "video": {"title": "Content video message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "gif": {"title": "Content video message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "audio": {"title": "Content audio message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "voice": {"title": "Content audio message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "document": {"title": "Content document message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "sticker": {"title": "Content sticker message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "location": {"title": "Content location message", "type": "object", "required": ["latitude", "longitude"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "live_location": {"title": "Content live location message", "type": "object", "required": ["latitude", "longitude"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "contact": {"title": "Content contact message", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "contact_list": {"title": "Content contacts message", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "interactive": {"title": "Message content interactive", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "system": {"title": "Message content interactive", "type": "object", "properties": {"body": {"description": "**Omitted**"}}}, "order": {"title": "Message content order", "type": "object", "properties": {"catalog_id": {"description": "**Omitted**"}, "product_items": {"description": "**Omitted**"}, "text": {"description": "**Omitted**"}}}, "product_items": {"title": "Message content product items", "type": "object", "properties": {"type": {"description": "**Omitted**"}}}, "action": {"title": "Message action", "type": "object", "properties": {"target": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "emoji": {"description": "**Omitted**"}}}, "context": {"title": "Message context", "description": "", "type": "object", "properties": {"forwarded": {"description": "**Omitted**"}, "forwarding_score": {"description": "**Omitted**"}, "mentions": {"description": "**Omitted**"}, "quoted_id": {"description": "**Omitted**"}, "quoted_type": {"description": "**Omitted**"}, "quoted_content": {"description": "**Omitted**"}, "quoted_author": {"description": "**Omitted**"}}}, "reactions": {"type": "array", "items": {"description": "**Omitted**"}, "description": "Reactions for message"}}}}, "count": {"type": "integer", "format": "int32", "description": "Count of requested messages", "default": 100, "minimum": -2147483648, "maximum": 2147483647}, "total": {"type": "integer", "format": "int32", "description": "Total number of returned messages", "minimum": -2147483648, "maximum": 2147483647}, "offset": {"type": "integer", "format": "int32", "description": "Offset of requested messages", "default": 0, "minimum": -2147483648, "maximum": 2147483647}}}
fd91a2ba-6522-4931-9a14-133934b39992/1e270466-bd16-49b1-8550-6629a874a629/0/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageAudio
500
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/1e270466-bd16-49b1-8550-6629a874a629/1/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageAudio
404
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/1e270466-bd16-49b1-8550-6629a874a629/2/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageAudio
400
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/1e270466-bd16-49b1-8550-6629a874a629/3/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageAudio
413
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/1e270466-bd16-49b1-8550-6629a874a629/4/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageAudio
201
null
{"sent": true, "message": {"id": "", "type": "text", "subtype": "", "chat_id": "", "from": "", "from_me": true, "from_name": "", "timestamp": 0, "status": "failed", "system": {}, "order": {}, "product_items": {}, "action": {}, "context": {}, "reactions": []}}
{"title": "Sent message", "type": "object", "required": ["sent"], "properties": {"sent": {"type": "boolean", "description": "Message sent"}, "message": {"title": "Message", "required": ["id", "type", "chat_id", "from_me", "timestamp"], "type": "object", "properties": {"id": {"type": "string", "description": "Message ID"}, "type": {"default": "text", "type": "string", "description": "Message type", "enum": ["text", "image", "video", "gif", "audio", "voice", "document", "location", "live_location", "contact", "contact_list", "sticker", "system", "call", "unknown", "action", "group_invite", "product", "interactive", "reply", "poll", "hsm"]}, "subtype": {"type": "string", "description": "Message subtype"}, "chat_id": {"type": "string", "description": "Chat ID"}, "from": {"description": "WhatsApp ID of the sender", "type": "string"}, "from_me": {"type": "boolean", "description": "Is message from me"}, "from_name": {"type": "string", "description": "Pushname of the sender"}, "timestamp": {"type": "number", "description": "Message timestamp"}, "status": {"type": "string", "description": "Message ack status", "enum": ["failed", "pending", "sent", "delivered", "read", "played", "deleted"], "x-enum-descriptions": ["Message failed to send (Red error triangle in WhatsApp Mobile)", "Message pending to send (One clock in WhatsApp Mobile)", "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)", "Voice-message played by recipient (Two blue checkmarks in WhatsApp Mobile)", "Message deleted by the user"]}, "text": {"title": "Content text message", "description": "", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "image": {"title": "Content image message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "video": {"title": "Content video message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "gif": {"title": "Content video message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "audio": {"title": "Content audio message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "voice": {"title": "Content audio message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "document": {"title": "Content document message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "sticker": {"title": "Content sticker message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "location": {"title": "Content location message", "type": "object", "required": ["latitude", "longitude"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "live_location": {"title": "Content live location message", "type": "object", "required": ["latitude", "longitude"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "contact": {"title": "Content contact message", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "contact_list": {"title": "Content contacts message", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "interactive": {"title": "Message content interactive", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "system": {"title": "Message content interactive", "type": "object", "properties": {"body": {"description": "**Omitted**"}}}, "order": {"title": "Message content order", "type": "object", "properties": {"catalog_id": {"description": "**Omitted**"}, "product_items": {"description": "**Omitted**"}, "text": {"description": "**Omitted**"}}}, "product_items": {"title": "Message content product items", "type": "object", "properties": {"type": {"description": "**Omitted**"}}}, "action": {"title": "Message action", "type": "object", "properties": {"target": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "emoji": {"description": "**Omitted**"}}}, "context": {"title": "Message context", "description": "", "type": "object", "properties": {"forwarded": {"description": "**Omitted**"}, "forwarding_score": {"description": "**Omitted**"}, "mentions": {"description": "**Omitted**"}, "quoted_id": {"description": "**Omitted**"}, "quoted_type": {"description": "**Omitted**"}, "quoted_content": {"description": "**Omitted**"}, "quoted_author": {"description": "**Omitted**"}}}, "reactions": {"type": "array", "items": {"description": "**Omitted**"}, "description": "Reactions for message"}}}}}
fd91a2ba-6522-4931-9a14-133934b39992/1e270466-bd16-49b1-8550-6629a874a629/5/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageAudio
429
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/1e270466-bd16-49b1-8550-6629a874a629/6/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageAudio
402
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/1e270466-bd16-49b1-8550-6629a874a629/7/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageAudio
401
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/1e270466-bd16-49b1-8550-6629a874a629/8/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageAudio
415
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/7889796d-50a1-477d-9b95-9291972a5707/0/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
forwardMessage
402
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/7889796d-50a1-477d-9b95-9291972a5707/1/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
forwardMessage
401
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/7889796d-50a1-477d-9b95-9291972a5707/2/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
forwardMessage
400
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/7889796d-50a1-477d-9b95-9291972a5707/3/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
forwardMessage
404
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/7889796d-50a1-477d-9b95-9291972a5707/4/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
forwardMessage
429
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/7889796d-50a1-477d-9b95-9291972a5707/5/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
forwardMessage
201
null
{"sent": true, "message": {"id": "", "type": "text", "subtype": "", "chat_id": "", "from": "", "from_me": true, "from_name": "", "timestamp": 0, "status": "failed", "system": {}, "order": {}, "product_items": {}, "action": {}, "context": {}, "reactions": []}}
{"title": "Sent message", "type": "object", "required": ["sent"], "properties": {"sent": {"type": "boolean", "description": "Message sent"}, "message": {"title": "Message", "required": ["id", "type", "chat_id", "from_me", "timestamp"], "type": "object", "properties": {"id": {"type": "string", "description": "Message ID"}, "type": {"default": "text", "type": "string", "description": "Message type", "enum": ["text", "image", "video", "gif", "audio", "voice", "document", "location", "live_location", "contact", "contact_list", "sticker", "system", "call", "unknown", "action", "group_invite", "product", "interactive", "reply", "poll", "hsm"]}, "subtype": {"type": "string", "description": "Message subtype"}, "chat_id": {"type": "string", "description": "Chat ID"}, "from": {"description": "WhatsApp ID of the sender", "type": "string"}, "from_me": {"type": "boolean", "description": "Is message from me"}, "from_name": {"type": "string", "description": "Pushname of the sender"}, "timestamp": {"type": "number", "description": "Message timestamp"}, "status": {"type": "string", "description": "Message ack status", "enum": ["failed", "pending", "sent", "delivered", "read", "played", "deleted"], "x-enum-descriptions": ["Message failed to send (Red error triangle in WhatsApp Mobile)", "Message pending to send (One clock in WhatsApp Mobile)", "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)", "Voice-message played by recipient (Two blue checkmarks in WhatsApp Mobile)", "Message deleted by the user"]}, "text": {"title": "Content text message", "description": "", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "image": {"title": "Content image message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "video": {"title": "Content video message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "gif": {"title": "Content video message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "audio": {"title": "Content audio message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "voice": {"title": "Content audio message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "document": {"title": "Content document message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "sticker": {"title": "Content sticker message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "location": {"title": "Content location message", "type": "object", "required": ["latitude", "longitude"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "live_location": {"title": "Content live location message", "type": "object", "required": ["latitude", "longitude"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "contact": {"title": "Content contact message", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "contact_list": {"title": "Content contacts message", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "interactive": {"title": "Message content interactive", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "system": {"title": "Message content interactive", "type": "object", "properties": {"body": {"description": "**Omitted**"}}}, "order": {"title": "Message content order", "type": "object", "properties": {"catalog_id": {"description": "**Omitted**"}, "product_items": {"description": "**Omitted**"}, "text": {"description": "**Omitted**"}}}, "product_items": {"title": "Message content product items", "type": "object", "properties": {"type": {"description": "**Omitted**"}}}, "action": {"title": "Message action", "type": "object", "properties": {"target": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "emoji": {"description": "**Omitted**"}}}, "context": {"title": "Message context", "description": "", "type": "object", "properties": {"forwarded": {"description": "**Omitted**"}, "forwarding_score": {"description": "**Omitted**"}, "mentions": {"description": "**Omitted**"}, "quoted_id": {"description": "**Omitted**"}, "quoted_type": {"description": "**Omitted**"}, "quoted_content": {"description": "**Omitted**"}, "quoted_author": {"description": "**Omitted**"}}}, "reactions": {"type": "array", "items": {"description": "**Omitted**"}, "description": "Reactions for message"}}}}}
fd91a2ba-6522-4931-9a14-133934b39992/7889796d-50a1-477d-9b95-9291972a5707/6/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
forwardMessage
500
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/9a041308-2511-47f7-9b39-6417c79f8f39/0/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getContact
400
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/9a041308-2511-47f7-9b39-6417c79f8f39/1/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getContact
404
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/9a041308-2511-47f7-9b39-6417c79f8f39/2/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getContact
200
null
{"id": "", "name": "", "pushname": "", "is_business": true, "profile_pic": "", "status": ""}
{"title": "WA Contact", "type": "object", "properties": {"id": {"type": "string", "description": "WA ID"}, "name": {"type": "string", "description": "Contact title from contact book"}, "pushname": {"type": "string", "description": "Account name from WA or WA Business name"}, "is_business": {"type": "boolean", "description": "Is a business account"}, "profile_pic": {"type": "string", "description": "Profile picture URL"}, "status": {"type": "string", "description": "Contact status"}}, "required": ["id", "name"]}
fd91a2ba-6522-4931-9a14-133934b39992/9a041308-2511-47f7-9b39-6417c79f8f39/3/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getContact
500
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/605bce40-540c-4a23-b1e4-76b2070681cf/0/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendContact
401
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/605bce40-540c-4a23-b1e4-76b2070681cf/1/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendContact
429
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/605bce40-540c-4a23-b1e4-76b2070681cf/2/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendContact
400
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/605bce40-540c-4a23-b1e4-76b2070681cf/3/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendContact
201
null
{"sent": true, "message": {"id": "", "type": "text", "subtype": "", "chat_id": "", "from": "", "from_me": true, "from_name": "", "timestamp": 0, "status": "failed", "system": {}, "order": {}, "product_items": {}, "action": {}, "context": {}, "reactions": []}}
{"title": "Sent message", "type": "object", "required": ["sent"], "properties": {"sent": {"type": "boolean", "description": "Message sent"}, "message": {"title": "Message", "required": ["id", "type", "chat_id", "from_me", "timestamp"], "type": "object", "properties": {"id": {"type": "string", "description": "Message ID"}, "type": {"default": "text", "type": "string", "description": "Message type", "enum": ["text", "image", "video", "gif", "audio", "voice", "document", "location", "live_location", "contact", "contact_list", "sticker", "system", "call", "unknown", "action", "group_invite", "product", "interactive", "reply", "poll", "hsm"]}, "subtype": {"type": "string", "description": "Message subtype"}, "chat_id": {"type": "string", "description": "Chat ID"}, "from": {"description": "WhatsApp ID of the sender", "type": "string"}, "from_me": {"type": "boolean", "description": "Is message from me"}, "from_name": {"type": "string", "description": "Pushname of the sender"}, "timestamp": {"type": "number", "description": "Message timestamp"}, "status": {"type": "string", "description": "Message ack status", "enum": ["failed", "pending", "sent", "delivered", "read", "played", "deleted"], "x-enum-descriptions": ["Message failed to send (Red error triangle in WhatsApp Mobile)", "Message pending to send (One clock in WhatsApp Mobile)", "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)", "Voice-message played by recipient (Two blue checkmarks in WhatsApp Mobile)", "Message deleted by the user"]}, "text": {"title": "Content text message", "description": "", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "image": {"title": "Content image message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "video": {"title": "Content video message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "gif": {"title": "Content video message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "audio": {"title": "Content audio message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "voice": {"title": "Content audio message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "document": {"title": "Content document message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "sticker": {"title": "Content sticker message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "location": {"title": "Content location message", "type": "object", "required": ["latitude", "longitude"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "live_location": {"title": "Content live location message", "type": "object", "required": ["latitude", "longitude"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "contact": {"title": "Content contact message", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "contact_list": {"title": "Content contacts message", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "interactive": {"title": "Message content interactive", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "system": {"title": "Message content interactive", "type": "object", "properties": {"body": {"description": "**Omitted**"}}}, "order": {"title": "Message content order", "type": "object", "properties": {"catalog_id": {"description": "**Omitted**"}, "product_items": {"description": "**Omitted**"}, "text": {"description": "**Omitted**"}}}, "product_items": {"title": "Message content product items", "type": "object", "properties": {"type": {"description": "**Omitted**"}}}, "action": {"title": "Message action", "type": "object", "properties": {"target": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "emoji": {"description": "**Omitted**"}}}, "context": {"title": "Message context", "description": "", "type": "object", "properties": {"forwarded": {"description": "**Omitted**"}, "forwarding_score": {"description": "**Omitted**"}, "mentions": {"description": "**Omitted**"}, "quoted_id": {"description": "**Omitted**"}, "quoted_type": {"description": "**Omitted**"}, "quoted_content": {"description": "**Omitted**"}, "quoted_author": {"description": "**Omitted**"}}}, "reactions": {"type": "array", "items": {"description": "**Omitted**"}, "description": "Reactions for message"}}}}}
fd91a2ba-6522-4931-9a14-133934b39992/605bce40-540c-4a23-b1e4-76b2070681cf/4/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendContact
404
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/605bce40-540c-4a23-b1e4-76b2070681cf/5/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendContact
500
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/61dde923-0374-4dc2-b4fc-c34bd5845d64/0/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getContacts
400
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/61dde923-0374-4dc2-b4fc-c34bd5845d64/1/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getContacts
500
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/61dde923-0374-4dc2-b4fc-c34bd5845d64/2/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getContacts
404
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/61dde923-0374-4dc2-b4fc-c34bd5845d64/3/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getContacts
200
null
{"contacts": [{"id": "", "name": "", "pushname": "", "is_business": true, "profile_pic": "", "status": ""}], "count": 0, "total": 0, "offset": 0}
{"title": "List of contacts", "type": "object", "allOf": [{"type": "object", "properties": {"contacts": {"title": "Contacts", "type": "array", "items": {"title": "WA Contact", "type": "object", "properties": {"id": {"type": "string", "description": "WA ID"}, "name": {"type": "string", "description": "Contact title from contact book"}, "pushname": {"type": "string", "description": "Account name from WA or WA Business name"}, "is_business": {"type": "boolean", "description": "Is a business account"}, "profile_pic": {"type": "string", "description": "Profile picture URL"}, "status": {"type": "string", "description": "Contact status"}}, "required": ["id", "name"]}}}}, {"title": "Iterator parameters", "type": "object", "properties": {"count": {"type": "integer", "format": "int32", "description": "Count of requested chats", "default": 20, "minimum": -2147483648, "maximum": 2147483647}, "total": {"type": "integer", "format": "int32", "description": "Total number of returned chats", "minimum": -2147483648, "maximum": 2147483647}, "offset": {"type": "integer", "format": "int32", "description": "Offset of requested chats", "default": 0, "minimum": -2147483648, "maximum": 2147483647}}}]}
fd91a2ba-6522-4931-9a14-133934b39992/f448c2ec-7320-4b26-a118-d936f5da096d/0/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageText
401
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/f448c2ec-7320-4b26-a118-d936f5da096d/1/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageText
400
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/f448c2ec-7320-4b26-a118-d936f5da096d/2/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageText
402
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/f448c2ec-7320-4b26-a118-d936f5da096d/3/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageText
429
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/f448c2ec-7320-4b26-a118-d936f5da096d/4/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageText
201
null
{"sent": true, "message": {"id": "", "type": "text", "subtype": "", "chat_id": "", "from": "", "from_me": true, "from_name": "", "timestamp": 0, "status": "failed", "system": {}, "order": {}, "product_items": {}, "action": {}, "context": {}, "reactions": []}}
{"title": "Sent message", "type": "object", "required": ["sent"], "properties": {"sent": {"type": "boolean", "description": "Message sent"}, "message": {"title": "Message", "required": ["id", "type", "chat_id", "from_me", "timestamp"], "type": "object", "properties": {"id": {"type": "string", "description": "Message ID"}, "type": {"default": "text", "type": "string", "description": "Message type", "enum": ["text", "image", "video", "gif", "audio", "voice", "document", "location", "live_location", "contact", "contact_list", "sticker", "system", "call", "unknown", "action", "group_invite", "product", "interactive", "reply", "poll", "hsm"]}, "subtype": {"type": "string", "description": "Message subtype"}, "chat_id": {"type": "string", "description": "Chat ID"}, "from": {"description": "WhatsApp ID of the sender", "type": "string"}, "from_me": {"type": "boolean", "description": "Is message from me"}, "from_name": {"type": "string", "description": "Pushname of the sender"}, "timestamp": {"type": "number", "description": "Message timestamp"}, "status": {"type": "string", "description": "Message ack status", "enum": ["failed", "pending", "sent", "delivered", "read", "played", "deleted"], "x-enum-descriptions": ["Message failed to send (Red error triangle in WhatsApp Mobile)", "Message pending to send (One clock in WhatsApp Mobile)", "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)", "Voice-message played by recipient (Two blue checkmarks in WhatsApp Mobile)", "Message deleted by the user"]}, "text": {"title": "Content text message", "description": "", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "image": {"title": "Content image message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "video": {"title": "Content video message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "gif": {"title": "Content video message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "audio": {"title": "Content audio message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "voice": {"title": "Content audio message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "document": {"title": "Content document message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "sticker": {"title": "Content sticker message", "type": "object", "required": ["id"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "location": {"title": "Content location message", "type": "object", "required": ["latitude", "longitude"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "live_location": {"title": "Content live location message", "type": "object", "required": ["latitude", "longitude"], "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "contact": {"title": "Content contact message", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "contact_list": {"title": "Content contacts message", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "interactive": {"title": "Message content interactive", "type": "object", "allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "system": {"title": "Message content interactive", "type": "object", "properties": {"body": {"description": "**Omitted**"}}}, "order": {"title": "Message content order", "type": "object", "properties": {"catalog_id": {"description": "**Omitted**"}, "product_items": {"description": "**Omitted**"}, "text": {"description": "**Omitted**"}}}, "product_items": {"title": "Message content product items", "type": "object", "properties": {"type": {"description": "**Omitted**"}}}, "action": {"title": "Message action", "type": "object", "properties": {"target": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "emoji": {"description": "**Omitted**"}}}, "context": {"title": "Message context", "description": "", "type": "object", "properties": {"forwarded": {"description": "**Omitted**"}, "forwarding_score": {"description": "**Omitted**"}, "mentions": {"description": "**Omitted**"}, "quoted_id": {"description": "**Omitted**"}, "quoted_type": {"description": "**Omitted**"}, "quoted_content": {"description": "**Omitted**"}, "quoted_author": {"description": "**Omitted**"}}}, "reactions": {"type": "array", "items": {"description": "**Omitted**"}, "description": "Reactions for message"}}}}}
fd91a2ba-6522-4931-9a14-133934b39992/f448c2ec-7320-4b26-a118-d936f5da096d/5/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageText
413
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/f448c2ec-7320-4b26-a118-d936f5da096d/6/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
sendMessageText
500
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/c6d1d9a8-1658-404c-a11f-a9ed5e12c3bf/0/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
checkPhones
402
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/c6d1d9a8-1658-404c-a11f-a9ed5e12c3bf/1/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
checkPhones
200
null
{"contacts": [{"input": "", "status": "valid", "wa_id": ""}]}
{"title": "Check contact response", "description": "", "type": "object", "allOf": [{"type": "object", "properties": {"contacts": {"type": "array", "items": {"title": "Check contact", "description": "", "type": "object", "properties": {"input": {"description": "The value you sent in the contacts field of the JSON request.", "type": "string"}, "status": {"description": "Status of the user.", "enum": ["valid", "invalid"], "type": "string"}, "wa_id": {"description": "WhatsApp user identifier that can be used in other API calls. Only returned if the status is valid.", "type": "string"}}}}}}]}
fd91a2ba-6522-4931-9a14-133934b39992/c6d1d9a8-1658-404c-a11f-a9ed5e12c3bf/2/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
checkPhones
429
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/c6d1d9a8-1658-404c-a11f-a9ed5e12c3bf/3/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
checkPhones
500
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/c6d1d9a8-1658-404c-a11f-a9ed5e12c3bf/4/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
checkPhones
401
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/c6d1d9a8-1658-404c-a11f-a9ed5e12c3bf/5/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
checkPhones
400
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/4ea99c00-6eb5-41dd-aab6-c9e5c399d3b9/0/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
resetChannelSettings
500
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/4ea99c00-6eb5-41dd-aab6-c9e5c399d3b9/1/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
resetChannelSettings
409
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/4ea99c00-6eb5-41dd-aab6-c9e5c399d3b9/2/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
resetChannelSettings
200
null
{"success": true}
{"title": "ResponseSuccess", "type": "object", "properties": {"success": {"type": "boolean"}}}
fd91a2ba-6522-4931-9a14-133934b39992/4487d252-0af6-49c8-aed0-1a7fe6b50124/0/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
checkHealth
500
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/4487d252-0af6-49c8-aed0-1a7fe6b50124/1/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
checkHealth
200
null
{"start_at": 0, "uptime": 0, "status": {"code": 0, "text": "NOT_INIT"}, "user": {"id": "", "name": "", "pushname": "", "is_business": true, "profile_pic": "", "status": ""}}
{"title": "Health response", "type": "object", "properties": {"start_at": {"type": "number", "description": "Date timestamp when channel started on the server."}, "uptime": {"type": "number", "description": "Seconds have passed since the start of the instance."}, "status": {"title": "Channel status", "type": "object", "properties": {"code": {"type": "number", "description": "Status code"}, "text": {"type": "string", "description": "Status text", "enum": ["NOT_INIT", "INIT", "LAUNCH", "QR", "AUTH", "ERROR"], "x-enum-descriptions": ["Not initialized", "Initialized", "Launched", "Scan QR code", "Authorize", "Error"]}}, "required": ["code", "text"]}, "user": {"title": "WA Contact", "type": "object", "properties": {"id": {"type": "string", "description": "WA ID"}, "name": {"type": "string", "description": "Contact title from contact book"}, "pushname": {"type": "string", "description": "Account name from WA or WA Business name"}, "is_business": {"type": "boolean", "description": "Is a business account"}, "profile_pic": {"type": "string", "description": "Profile picture URL"}, "status": {"type": "string", "description": "Contact status"}}, "required": ["id", "name"]}}, "required": ["start_at", "uptime", "status"]}
fd91a2ba-6522-4931-9a14-133934b39992/8c7e3138-ddcc-43b6-ac22-c121d95bc5ff/0/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getChannelSettings
500
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/8c7e3138-ddcc-43b6-ac22-c121d95bc5ff/1/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getChannelSettings
200
null
{"callback_backoff_delay_ms": 0, "max_callback_backoff_delay_ms": 0, "callback_persist": true, "media": {"auto_download": ["image"]}, "webhooks": [{"url": "", "events": [{"type": "message", "method": "post"}], "mode": "body"}], "on_call_pager": "", "pass_through": true, "sent_status": false, "proxy": ""}
{"title": "Channel Settings", "type": "object", "properties": {"callback_backoff_delay_ms": {"description": "Backoff delay for a failed callback in milliseconds This setting is used to configure the amount of time the backoff delays before retrying a failed callback. The backoff delay increases linearly by this value each time a callback fails to get a HTTPS 200 OK response. The backoff delay is capped by the max_callback_backoff_delay_ms setting.", "default": 3000, "type": "number"}, "max_callback_backoff_delay_ms": {"description": "Maximum delay for a failed callback in milliseconds", "default": 900000, "type": "number"}, "callback_persist": {"description": "Stores callbacks on disk until they are successfully acknowledged by the Webhook or not. Restart required.", "default": true, "type": "boolean"}, "media": {"title": "Media", "required": ["auto_download"], "type": "object", "properties": {"auto_download": {"description": "An array specifying which types of media to automatically download.", "type": "array", "items": {"enum": ["image", "audio", "voice", "video", "document"], "type": "string"}}}}, "webhooks": {"title": "Webhooks", "type": "array", "items": {"title": "Webhook", "type": "object", "required": ["url"], "properties": {"url": {"description": "Inbound and outbound notifications are routed to this URL.", "type": "string"}, "events": {"type": "array", "items": {"type": "object", "properties": {"type": {"type": "string", "enum": ["message", "ack", "chat", "status", "service"]}, "method": {"type": "string", "enum": ["post", "put", "delete", "patch"]}}}, "default": [{"type": "message", "method": "put"}], "description": "Tracked events. <br/>\"message\" - got new message;<br/>\"ack\" - got message status;<br/>\"chat\" - got chat/dialog update;<br/>\"status\" - instance status changed;<br/>\"service\" - special notifications"}, "mode": {"type": "string", "default": "body", "enum": ["body", "path", "method"], "description": "Request method for sending hook."}}}}, "on_call_pager": {"description": "Set to valid WhatsApp Group with users who wish to see alerts for critical errors and messages.", "type": "string"}, "pass_through": {"description": "When true, removes messages from the local database after they are delivered to or read by the recipient. When false, saves all messages on local storage until they are explicitly deleted. When messages are sent, they are stored in a local database. This database is used as the application's history. Since the business keeps its own history, you can specify whether you want message pass_through or not. Restart required.", "default": true, "type": "boolean"}, "sent_status": {"description": "Receive a notification that a message is sent to server. When true, you will receive a message indicating that a message has been sent. If false (default), you will not receive notification.", "default": false, "type": "boolean"}, "proxy": {"description": "Set to valid WhatsApp Group with users who wish to see alerts for critical errors and messages.", "type": "string"}}}
fd91a2ba-6522-4931-9a14-133934b39992/980c8e0c-9f2e-4ff7-a588-5adf90cdca72/0/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getLimits
500
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/980c8e0c-9f2e-4ff7-a588-5adf90cdca72/1/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getLimits
204
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/980c8e0c-9f2e-4ff7-a588-5adf90cdca72/2/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
getLimits
200
null
{"messages": 100, "chats": [], "checks": 100}
{"title": "Trial limits", "type": "object", "properties": {"messages": {"type": "integer", "description": "Maximum number of messages that can be sent"}, "chats": {"type": "array", "items": {"type": "string", "description": "Chat ID", "pattern": "^[\\d-]{10,31}@[\\w\\.]{1,}$"}, "description": "List of chat IDs that can be used"}, "checks": {"type": "integer", "description": "Maximum number of check phone numbers"}}, "required": ["messages", "chats", "checks"]}
fd91a2ba-6522-4931-9a14-133934b39992/ba3d9ff5-dccb-4010-a2ee-b44e089bd097/0/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
updateChannelSettings
If a field is not present in the request, no change is made to that setting. For example, if 'proxy' is not sent with the request, the existing configuration for 'proxy' is unchanged.
400
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/ba3d9ff5-dccb-4010-a2ee-b44e089bd097/1/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
updateChannelSettings
If a field is not present in the request, no change is made to that setting. For example, if 'proxy' is not sent with the request, the existing configuration for 'proxy' is unchanged.
500
null
{"error": {"code": 0, "message": "", "details": "", "href": "", "support": ""}}
{"title": "ResponseError", "type": "object", "properties": {"error": {"title": "Error", "type": "object", "required": ["code", "message"], "properties": {"code": {"format": "int32", "description": "See the https://whapi.cloud/docs/whatsapp/api/errors for more information.", "type": "integer", "minimum": -2147483648, "maximum": 2147483647}, "message": {"description": "error message", "type": "string"}, "details": {"description": "error detail", "type": "string"}, "href": {"description": "location for error detail", "type": "string"}, "support": {"description": "support contact", "type": "string"}}}}, "required": ["error"]}
fd91a2ba-6522-4931-9a14-133934b39992/ba3d9ff5-dccb-4010-a2ee-b44e089bd097/2/0
WhatsApp API for developers / Free plan
Integrate WhatsApp without limits to your own services or apps! Groups & Buttons, Technical support & Guides. API works stably and does not crash during updates
0.1
updateChannelSettings
If a field is not present in the request, no change is made to that setting. For example, if 'proxy' is not sent with the request, the existing configuration for 'proxy' is unchanged.
200
null
{"before_update": {"callback_backoff_delay_ms": 0, "max_callback_backoff_delay_ms": 0, "callback_persist": true, "media": {"auto_download": ["image"]}, "webhooks": [{"url": "", "events": [{"type": "message", "method": "post"}], "mode": "body"}], "on_call_pager": "", "pass_through": true, "sent_status": false, "proxy": ""}, "after_update": {"callback_backoff_delay_ms": 0, "max_callback_backoff_delay_ms": 0, "callback_persist": true, "media": {"auto_download": ["image"]}, "webhooks": [{"url": "", "events": [{"type": "message", "method": "post"}], "mode": "body"}], "on_call_pager": "", "pass_through": true, "sent_status": false, "proxy": ""}, "changes": ["callback_backoff_delay_ms"]}
{"title": "Update settings", "type": "object", "required": ["before_update", "after_update", "changes"], "properties": {"before_update": {"title": "Channel Settings", "type": "object", "properties": {"callback_backoff_delay_ms": {"description": "Backoff delay for a failed callback in milliseconds This setting is used to configure the amount of time the backoff delays before retrying a failed callback. The backoff delay increases linearly by this value each time a callback fails to get a HTTPS 200 OK response. The backoff delay is capped by the max_callback_backoff_delay_ms setting.", "default": 3000, "type": "number"}, "max_callback_backoff_delay_ms": {"description": "Maximum delay for a failed callback in milliseconds", "default": 900000, "type": "number"}, "callback_persist": {"description": "Stores callbacks on disk until they are successfully acknowledged by the Webhook or not. Restart required.", "default": true, "type": "boolean"}, "media": {"title": "Media", "required": ["auto_download"], "type": "object", "properties": {"auto_download": {"description": "An array specifying which types of media to automatically download.", "type": "array", "items": {"enum": ["image", "audio", "voice", "video", "document"], "type": "string"}}}}, "webhooks": {"title": "Webhooks", "type": "array", "items": {"title": "Webhook", "type": "object", "required": ["url"], "properties": {"url": {"description": "Inbound and outbound notifications are routed to this URL.", "type": "string"}, "events": {"type": "array", "items": {"type": "object", "properties": {"type": {"type": "string", "enum": ["message", "ack", "chat", "status", "service"]}, "method": {"type": "string", "enum": ["post", "put", "delete", "patch"]}}}, "default": [{"type": "message", "method": "put"}], "description": "Tracked events. <br/>\"message\" - got new message;<br/>\"ack\" - got message status;<br/>\"chat\" - got chat/dialog update;<br/>\"status\" - instance status changed;<br/>\"service\" - special notifications"}, "mode": {"type": "string", "default": "body", "enum": ["body", "path", "method"], "description": "Request method for sending hook."}}}}, "on_call_pager": {"description": "Set to valid WhatsApp Group with users who wish to see alerts for critical errors and messages.", "type": "string"}, "pass_through": {"description": "When true, removes messages from the local database after they are delivered to or read by the recipient. When false, saves all messages on local storage until they are explicitly deleted. When messages are sent, they are stored in a local database. This database is used as the application's history. Since the business keeps its own history, you can specify whether you want message pass_through or not. Restart required.", "default": true, "type": "boolean"}, "sent_status": {"description": "Receive a notification that a message is sent to server. When true, you will receive a message indicating that a message has been sent. If false (default), you will not receive notification.", "default": false, "type": "boolean"}, "proxy": {"description": "Set to valid WhatsApp Group with users who wish to see alerts for critical errors and messages.", "type": "string"}}}, "after_update": {"title": "Channel Settings", "type": "object", "properties": {"callback_backoff_delay_ms": {"description": "Backoff delay for a failed callback in milliseconds This setting is used to configure the amount of time the backoff delays before retrying a failed callback. The backoff delay increases linearly by this value each time a callback fails to get a HTTPS 200 OK response. The backoff delay is capped by the max_callback_backoff_delay_ms setting.", "default": 3000, "type": "number"}, "max_callback_backoff_delay_ms": {"description": "Maximum delay for a failed callback in milliseconds", "default": 900000, "type": "number"}, "callback_persist": {"description": "Stores callbacks on disk until they are successfully acknowledged by the Webhook or not. Restart required.", "default": true, "type": "boolean"}, "media": {"title": "Media", "required": ["auto_download"], "type": "object", "properties": {"auto_download": {"description": "An array specifying which types of media to automatically download.", "type": "array", "items": {"enum": ["image", "audio", "voice", "video", "document"], "type": "string"}}}}, "webhooks": {"title": "Webhooks", "type": "array", "items": {"title": "Webhook", "type": "object", "required": ["url"], "properties": {"url": {"description": "Inbound and outbound notifications are routed to this URL.", "type": "string"}, "events": {"type": "array", "items": {"type": "object", "properties": {"type": {"type": "string", "enum": ["message", "ack", "chat", "status", "service"]}, "method": {"type": "string", "enum": ["post", "put", "delete", "patch"]}}}, "default": [{"type": "message", "method": "put"}], "description": "Tracked events. <br/>\"message\" - got new message;<br/>\"ack\" - got message status;<br/>\"chat\" - got chat/dialog update;<br/>\"status\" - instance status changed;<br/>\"service\" - special notifications"}, "mode": {"type": "string", "default": "body", "enum": ["body", "path", "method"], "description": "Request method for sending hook."}}}}, "on_call_pager": {"description": "Set to valid WhatsApp Group with users who wish to see alerts for critical errors and messages.", "type": "string"}, "pass_through": {"description": "When true, removes messages from the local database after they are delivered to or read by the recipient. When false, saves all messages on local storage until they are explicitly deleted. When messages are sent, they are stored in a local database. This database is used as the application's history. Since the business keeps its own history, you can specify whether you want message pass_through or not. Restart required.", "default": true, "type": "boolean"}, "sent_status": {"description": "Receive a notification that a message is sent to server. When true, you will receive a message indicating that a message has been sent. If false (default), you will not receive notification.", "default": false, "type": "boolean"}, "proxy": {"description": "Set to valid WhatsApp Group with users who wish to see alerts for critical errors and messages.", "type": "string"}}}, "changes": {"type": "array", "items": {"type": "string", "enum": ["callback_backoff_delay_ms", "max_callback_backoff_delay_ms", "callback_persist", "media", "webhooks", "on_call_pager", "pass_through", "sent_status"]}}}}
e9eabadf-2020-4124-bf0e-56f0b9585c83/2cceabc0-d43c-4ad8-9731-24794999d3a6/0/0
Appraiser
Get details of an appraiser license. Validate an appraiser license given lastname, state, and license from 55 US States. Data set is updated periodically. This API assists Appraisal and Real Estate Software .exe applications, Web Apps and Mobile Apps. Built for software that serves Appraisers, Realtors, Lending, Loan, Home Insurance Software Companies. Fast, less code, less load for your application and server. Save much more development time and for your software end-users.
null
GetLicenseDetails
Given Lastname, State, Appraiser License Number, API will return the details of each license (if there're many).
200
Response
{"data": [{"license_number": "AR-019018", "lastname": "Aaron", "firstname": "David", "middlename": "J", "name_suffix": "", "effective_date": "08/05/2011", "expired_date": "08/04/2023", "license_type": "Certified Residential", "status": "active", "company": "Aaron and Associates, Inc.", "phone": "559-709-3295", "street": "1885 North Jasmine Avenue", "city": "Clovis", "state": "CA", "county": "FRESNO", "zip": "93619", "conforms_aqb": "Yes"}]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"data": {"type": "array", "items": {"type": "object", "properties": {"license_number": {"type": "string"}, "lastname": {"type": "string"}, "firstname": {"type": "string"}, "middlename": {"type": "string"}, "name_suffix": {"type": "string"}, "effective_date": {"type": "string"}, "expired_date": {"type": "string"}, "license_type": {"type": "string"}, "status": {"type": "string"}, "company": {"type": "string"}, "phone": {"type": "string"}, "street": {"type": "string"}, "city": {"type": "string"}, "state": {"type": "string"}, "county": {"type": "string"}, "zip": {"type": "string"}, "conforms_aqb": {"type": "string"}}, "required": ["city", "company", "conforms_aqb", "county", "effective_date", "expired_date", "firstname", "lastname", "license_number", "license_type", "middlename", "name_suffix", "phone", "state", "status", "street", "zip"]}}}, "required": ["data"]}
e9eabadf-2020-4124-bf0e-56f0b9585c83/7844c452-0619-43c6-aafa-2694a1f6edc5/0/0
Appraiser
Get details of an appraiser license. Validate an appraiser license given lastname, state, and license from 55 US States. Data set is updated periodically. This API assists Appraisal and Real Estate Software .exe applications, Web Apps and Mobile Apps. Built for software that serves Appraisers, Realtors, Lending, Loan, Home Insurance Software Companies. Fast, less code, less load for your application and server. Save much more development time and for your software end-users.
null
ValidateLicense
Given Lastname, State, Appraiser License Number, API will evaluate and return if the license is valid or not based on the License Status and Expiration Date. Response: valid=true when the License Expiration Date is still valid and License Status is active. Else, valid=false. The response will include multiple licenses and the validity of each license of the same appraiser if any.
200
Response
{"data": [{"license_number": "AR-019018", "lastname": "Aaron", "firstname": "David", "expired_date": "08/04/2023", "license_type": "Certified Residential", "status": "active", "valid": true}]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"data": {"type": "array", "items": {"type": "object", "properties": {"license_number": {"type": "string"}, "lastname": {"type": "string"}, "firstname": {"type": "string"}, "expired_date": {"type": "string"}, "license_type": {"type": "string"}, "status": {"type": "string"}, "valid": {"type": "boolean"}}, "required": ["expired_date", "firstname", "lastname", "license_number", "license_type", "status", "valid"]}}}, "required": ["data"]}
99244b62-1c6d-4af9-9f92-62565407fab4/3325a964-fa1f-4067-a3f7-356789a09398/1/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
AddAuthentication
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/3325a964-fa1f-4067-a3f7-356789a09398/2/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
AddAuthentication
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/b25efb84-c044-4a9b-b6c3-29d16761f7a2/1/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
DownloadAttachment
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/b25efb84-c044-4a9b-b6c3-29d16761f7a2/3/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
DownloadAttachment
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/b25efb84-c044-4a9b-b6c3-29d16761f7a2/5/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
DownloadAttachment
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/b25efb84-c044-4a9b-b6c3-29d16761f7a2/6/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
DownloadAttachment
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/0609823c-eb81-4c2e-abfd-b4ded13d92c6/0/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
ListDocuments
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/0609823c-eb81-4c2e-abfd-b4ded13d92c6/1/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
ListDocuments
200
null
{"pageDetails": {"pageSize": 0, "page": 0, "totalRecordsCount": 0, "totalPages": 0, "sortedColumn": "", "sortDirection": ""}, "result": [{"documentId": "", "senderDetail": {"name": "", "privateMessage": "", "emailAddress": "", "isViewed": false}, "ccDetails": [{"emailAddress": "", "isViewed": false}], "createdDate": 0, "activityDate": 0, "activityBy": "", "messageTitle": "", "status": "InProgress", "signerDetails": [{"signerName": "", "signerRole": "", "signerEmail": "", "status": "None", "enableAccessCode": true, "isAuthenticationFailed": false, "enableEmailOTP": true, "isDeliveryFailed": false, "isViewed": false, "order": 0, "signerType": "Signer", "hostEmail": "", "hostName": "", "isReassigned": true, "privateMessage": "", "formFields": [], "language": 1}], "expiryDate": 0, "enableSigningOrder": true, "isDeleted": true, "labels": []}]}
{"title": "DocumentRecords", "type": "object", "properties": {"pageDetails": {"title": "PageDetails", "type": "object", "properties": {"pageSize": {"title": "Int32", "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "page": {"title": "Int32", "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "totalRecordsCount": {"title": "Int32", "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "totalPages": {"title": "Int32", "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "sortedColumn": {"title": "String", "type": ["string", "null"]}, "sortDirection": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}, "result": {"title": "List`1", "type": ["array", "null"], "items": {"title": "Document", "type": "object", "properties": {"documentId": {"title": "String", "type": ["string", "null"]}, "senderDetail": {"title": "DocumentSenderDetail", "type": "object", "properties": {"name": {"title": "String", "type": ["string", "null"]}, "privateMessage": {"title": "String", "type": ["string", "null"]}, "emailAddress": {"title": "String", "type": ["string", "null"]}, "isViewed": {"title": "Boolean", "type": "boolean", "default": false}}, "additionalProperties": false}, "ccDetails": {"title": "DocumentCcDetails[]", "type": ["array", "null"], "items": {"title": "DocumentCcDetails", "type": "object", "properties": {"emailAddress": {"title": "String", "type": ["string", "null"]}, "isViewed": {"title": "Boolean", "type": "boolean", "default": false}}, "additionalProperties": false}}, "createdDate": {"title": "Int64", "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activityDate": {"title": "Int64", "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activityBy": {"title": "String", "type": ["string", "null"]}, "messageTitle": {"title": "String", "type": ["string", "null"]}, "status": {"title": "DocumentStatus", "enum": ["InProgress", "Completed", "Declined", "Expired", "Revoked", "Draft"], "type": "string"}, "signerDetails": {"title": "DocumentSignerDetails[]", "type": ["array", "null"], "items": {"title": "DocumentSignerDetails", "type": "object", "properties": {"signerName": {"title": "String", "type": ["string", "null"]}, "signerRole": {"title": "String", "type": ["string", "null"]}, "signerEmail": {"title": "String", "type": ["string", "null"]}, "status": {"title": "SignerStatus", "enum": ["None", "NotCompleted", "Completed", "Declined", "Revoked"], "type": "string"}, "enableAccessCode": {"title": "Boolean", "type": "boolean"}, "isAuthenticationFailed": {"title": "Nullable`1", "type": ["boolean", "null"], "default": false}, "enableEmailOTP": {"title": "Boolean", "type": "boolean"}, "isDeliveryFailed": {"title": "Boolean", "type": "boolean", "default": false}, "isViewed": {"title": "Boolean", "type": "boolean", "default": false}, "order": {"title": "Int32", "type": "integer", "format": "int32", "default": 0, "minimum": -2147483648, "maximum": 2147483647}, "signerType": {"title": "SignerType", "enum": ["Signer", "Reviewer", "InPersonSigner"], "type": "string", "default": "Signer"}, "hostEmail": {"title": "String", "type": ["string", "null"]}, "hostName": {"title": "String", "type": ["string", "null"]}, "isReassigned": {"title": "Boolean", "type": "boolean"}, "privateMessage": {"title": "String", "type": ["string", "null"]}, "formFields": {"title": "DocumentFormFields[]", "type": ["array", "null"], "items": {"title": "DocumentFormFields", "type": "object", "properties": {"id": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "value": {"description": "**Omitted**"}, "font": {"description": "**Omitted**"}, "isRequired": {"description": "**Omitted**"}, "isReadOnly": {"description": "**Omitted**"}, "lineHeight": {"description": "**Omitted**"}, "fontSize": {"description": "**Omitted**"}, "fontColor": {"description": "**Omitted**"}, "isUnderline": {"description": "**Omitted**"}, "isItalic": {"description": "**Omitted**"}, "isBold": {"description": "**Omitted**"}, "groupName": {"description": "**Omitted**"}, "placeholder": {"description": "**Omitted**"}, "validationtype": {"description": "**Omitted**"}, "validationCustomRegex": {"description": "**Omitted**"}, "validationCustomRegexMessage": {"description": "**Omitted**"}, "dateFormat": {"description": "**Omitted**"}, "imageInfo": {"description": "**Omitted**"}, "attachmentInfo": {"description": "**Omitted**"}, "fileInfo": {"description": "**Omitted**"}, "editableDateFieldSettings": {"description": "**Omitted**"}, "hyperlinkText": {"description": "**Omitted**"}, "conditionalRules": {"description": "**Omitted**"}, "bounds": {"description": "**Omitted**"}, "pageNumber": {"description": "**Omitted**"}, "dataSyncTag": {"description": "**Omitted**"}, "dropdownOptions": {"description": "**Omitted**"}, "textAlign": {"description": "**Omitted**"}}, "additionalProperties": false}}, "language": {"title": "Languages", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "type": "integer", "description": "<p>Description:</p><ul><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul>", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}}, "additionalProperties": false}}, "expiryDate": {"title": "Int64", "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "enableSigningOrder": {"title": "Boolean", "type": "boolean"}, "isDeleted": {"title": "Boolean", "type": "boolean"}, "labels": {"title": "List`1", "type": ["array", "null"], "items": {"title": "String", "type": "string"}}}, "additionalProperties": false}}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/e18e8fdc-0ac9-4c6f-9bd7-774a1e5d2285/0/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
RevokeDocument
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/e18e8fdc-0ac9-4c6f-9bd7-774a1e5d2285/1/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
RevokeDocument
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/9cac3353-b8d4-4722-b5ca-c5a40dda64dd/0/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
RemindDocument
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/9cac3353-b8d4-4722-b5ca-c5a40dda64dd/2/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
RemindDocument
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/9cac3353-b8d4-4722-b5ca-c5a40dda64dd/3/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
RemindDocument
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/9cac3353-b8d4-4722-b5ca-c5a40dda64dd/4/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
RemindDocument
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/964b0428-749f-4c97-be31-1d0c52200782/3/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
RemoveAuthentication
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/964b0428-749f-4c97-be31-1d0c52200782/4/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
RemoveAuthentication
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/964b0428-749f-4c97-be31-1d0c52200782/5/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
RemoveAuthentication
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/964b0428-749f-4c97-be31-1d0c52200782/6/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
RemoveAuthentication
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/71d9754b-13be-4bf1-8f8c-7a223b663015/1/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
/v1/document/changeRecipient
200
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/71d9754b-13be-4bf1-8f8c-7a223b663015/2/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
/v1/document/changeRecipient
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/71d9754b-13be-4bf1-8f8c-7a223b663015/3/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
/v1/document/changeRecipient
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/71d9754b-13be-4bf1-8f8c-7a223b663015/5/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
/v1/document/changeRecipient
200
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/f3f9730c-ee3d-44c5-8045-511240dc33c7/0/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
ChangeAccessCode
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/f3f9730c-ee3d-44c5-8045-511240dc33c7/2/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
ChangeAccessCode
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/f3f9730c-ee3d-44c5-8045-511240dc33c7/3/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
ChangeAccessCode
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/f3f9730c-ee3d-44c5-8045-511240dc33c7/6/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
ChangeAccessCode
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/694a3fa5-dee8-473f-966c-c16988c77f52/0/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
ExtendExpiry
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/694a3fa5-dee8-473f-966c-c16988c77f52/3/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
ExtendExpiry
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/694a3fa5-dee8-473f-966c-c16988c77f52/4/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
ExtendExpiry
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/694a3fa5-dee8-473f-966c-c16988c77f52/5/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
ExtendExpiry
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/46178504-4f1c-4e4e-a4df-e3f91d18dbc9/0/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
BehalfDocuments
200
null
{"pageDetails": {"pageSize": 0, "page": 0, "totalRecordsCount": 0, "totalPages": 0, "sortedColumn": "", "sortDirection": ""}, "result": [{"behalfOf": {"name": "", "emailAddress": ""}, "documentId": "", "senderDetail": {"name": "", "privateMessage": "", "emailAddress": "", "isViewed": false}, "ccDetails": [{"emailAddress": "", "isViewed": false}], "createdDate": 0, "activityDate": 0, "activityBy": "", "messageTitle": "", "status": "InProgress", "signerDetails": [{"signerName": "", "signerRole": "", "signerEmail": "", "status": "None", "enableAccessCode": true, "isAuthenticationFailed": false, "enableEmailOTP": true, "isDeliveryFailed": false, "isViewed": false, "order": 0, "signerType": "Signer", "hostEmail": "", "hostName": "", "isReassigned": true, "privateMessage": "", "formFields": [], "language": 1}], "expiryDate": 0, "enableSigningOrder": true, "isDeleted": true, "labels": []}]}
{"title": "BehalfDocumentRecords", "type": "object", "properties": {"pageDetails": {"title": "PageDetails", "type": "object", "properties": {"pageSize": {"title": "Int32", "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "page": {"title": "Int32", "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "totalRecordsCount": {"title": "Int32", "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "totalPages": {"title": "Int32", "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "sortedColumn": {"title": "String", "type": ["string", "null"]}, "sortDirection": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}, "result": {"title": "List`1", "type": ["array", "null"], "items": {"title": "BehalfDocument", "type": "object", "properties": {"behalfOf": {"title": "BehalfOf", "type": "object", "properties": {"name": {"title": "String", "type": ["string", "null"]}, "emailAddress": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}, "documentId": {"title": "String", "type": ["string", "null"]}, "senderDetail": {"title": "DocumentSenderDetail", "type": "object", "properties": {"name": {"title": "String", "type": ["string", "null"]}, "privateMessage": {"title": "String", "type": ["string", "null"]}, "emailAddress": {"title": "String", "type": ["string", "null"]}, "isViewed": {"title": "Boolean", "type": "boolean", "default": false}}, "additionalProperties": false}, "ccDetails": {"title": "DocumentCcDetails[]", "type": ["array", "null"], "items": {"title": "DocumentCcDetails", "type": "object", "properties": {"emailAddress": {"title": "String", "type": ["string", "null"]}, "isViewed": {"title": "Boolean", "type": "boolean", "default": false}}, "additionalProperties": false}}, "createdDate": {"title": "Int64", "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activityDate": {"title": "Int64", "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activityBy": {"title": "String", "type": ["string", "null"]}, "messageTitle": {"title": "String", "type": ["string", "null"]}, "status": {"title": "DocumentStatus", "enum": ["InProgress", "Completed", "Declined", "Expired", "Revoked", "Draft"], "type": "string"}, "signerDetails": {"title": "DocumentSignerDetails[]", "type": ["array", "null"], "items": {"title": "DocumentSignerDetails", "type": "object", "properties": {"signerName": {"title": "String", "type": ["string", "null"]}, "signerRole": {"title": "String", "type": ["string", "null"]}, "signerEmail": {"title": "String", "type": ["string", "null"]}, "status": {"title": "SignerStatus", "enum": ["None", "NotCompleted", "Completed", "Declined", "Revoked"], "type": "string"}, "enableAccessCode": {"title": "Boolean", "type": "boolean"}, "isAuthenticationFailed": {"title": "Nullable`1", "type": ["boolean", "null"], "default": false}, "enableEmailOTP": {"title": "Boolean", "type": "boolean"}, "isDeliveryFailed": {"title": "Boolean", "type": "boolean", "default": false}, "isViewed": {"title": "Boolean", "type": "boolean", "default": false}, "order": {"title": "Int32", "type": "integer", "format": "int32", "default": 0, "minimum": -2147483648, "maximum": 2147483647}, "signerType": {"title": "SignerType", "enum": ["Signer", "Reviewer", "InPersonSigner"], "type": "string", "default": "Signer"}, "hostEmail": {"title": "String", "type": ["string", "null"]}, "hostName": {"title": "String", "type": ["string", "null"]}, "isReassigned": {"title": "Boolean", "type": "boolean"}, "privateMessage": {"title": "String", "type": ["string", "null"]}, "formFields": {"title": "DocumentFormFields[]", "type": ["array", "null"], "items": {"title": "DocumentFormFields", "type": "object", "properties": {"id": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "value": {"description": "**Omitted**"}, "font": {"description": "**Omitted**"}, "isRequired": {"description": "**Omitted**"}, "isReadOnly": {"description": "**Omitted**"}, "lineHeight": {"description": "**Omitted**"}, "fontSize": {"description": "**Omitted**"}, "fontColor": {"description": "**Omitted**"}, "isUnderline": {"description": "**Omitted**"}, "isItalic": {"description": "**Omitted**"}, "isBold": {"description": "**Omitted**"}, "groupName": {"description": "**Omitted**"}, "placeholder": {"description": "**Omitted**"}, "validationtype": {"description": "**Omitted**"}, "validationCustomRegex": {"description": "**Omitted**"}, "validationCustomRegexMessage": {"description": "**Omitted**"}, "dateFormat": {"description": "**Omitted**"}, "imageInfo": {"description": "**Omitted**"}, "attachmentInfo": {"description": "**Omitted**"}, "fileInfo": {"description": "**Omitted**"}, "editableDateFieldSettings": {"description": "**Omitted**"}, "hyperlinkText": {"description": "**Omitted**"}, "conditionalRules": {"description": "**Omitted**"}, "bounds": {"description": "**Omitted**"}, "pageNumber": {"description": "**Omitted**"}, "dataSyncTag": {"description": "**Omitted**"}, "dropdownOptions": {"description": "**Omitted**"}, "textAlign": {"description": "**Omitted**"}}, "additionalProperties": false}}, "language": {"title": "Languages", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "type": "integer", "description": "<p>Description:</p><ul><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul>", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}}, "additionalProperties": false}}, "expiryDate": {"title": "Int64", "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "enableSigningOrder": {"title": "Boolean", "type": "boolean"}, "isDeleted": {"title": "Boolean", "type": "boolean"}, "labels": {"title": "List`1", "type": ["array", "null"], "items": {"title": "String", "type": "string"}}}, "additionalProperties": false}}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/46178504-4f1c-4e4e-a4df-e3f91d18dbc9/1/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
BehalfDocuments
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/46178504-4f1c-4e4e-a4df-e3f91d18dbc9/2/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
BehalfDocuments
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/a1f2bf6e-9e96-4ab7-9c11-e1f35b7799e1/0/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
DownloadDocument
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/a1f2bf6e-9e96-4ab7-9c11-e1f35b7799e1/1/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
DownloadDocument
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/a1f2bf6e-9e96-4ab7-9c11-e1f35b7799e1/3/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
DownloadDocument
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/a1f2bf6e-9e96-4ab7-9c11-e1f35b7799e1/7/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
DownloadDocument
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/e3addb6d-6439-4ba9-8678-3b3cb067e46f/1/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
GetEmbeddedSignLink
401
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/e3addb6d-6439-4ba9-8678-3b3cb067e46f/2/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
GetEmbeddedSignLink
200
null
{"signLink": ""}
{"title": "EmbeddedSigningLink", "type": "object", "properties": {"signLink": {"title": "Uri", "type": ["string", "null"], "format": "uri"}}, "additionalProperties": false}
99244b62-1c6d-4af9-9f92-62565407fab4/e3addb6d-6439-4ba9-8678-3b3cb067e46f/3/0
BoldSign
BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs.
null
GetEmbeddedSignLink
403
null
{"error": ""}
{"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false}