Orders

Mark an order complete

Call this once the code has worked. Valid only while the order is in sms_received.

Also served as POST /api/v1/order/{id}/complete.

post/api/v1/orders/{id}/complete

Request

  • Base URL: https://virtualsms.io
  • URL: https://virtualsms.io/api/v1/orders/{id}/complete
  • Auth: one of:
    • API key in header X-API-Key
    • API key in query parameter api_key

Path parameters

idstring uuid required

Response

Order completed

successboolean
order_idstring uuid
statusstring

Example response

{
  "status": "completed"
}

Changes

No recorded changes to this operation across all 1 revision of this API.