Skip to content

Topup Account Credit

WARNING

This endpoint is only relevant if you're utilizing the account credit system.

Topup (increase) an accounts messaging credit

Request

Endpoint

Messaging Plus expects a PATCH request

PATCH https://mplus.instagiv.com/account/{account-uuid}
KeyDescriptionExample
account-uuidAccount UUID to delete16e7c990-3a03-4b4b-b98f-732aae5bf8d1

Query strings

KeyRequiredDescriptionExample
keytrueOrganization API key (32‑character hex)?key=aaaabbbbcccc11112222333344445555

Body

json
{
    "topup": 400
}

Body parameters

KeyExpected valueDescription
topupintegerNumeric value to increase account credits by

Response

Success

Supplies a 200 response upon successful account topup with an empty JSON body.

Error responses

  • 400 Bad Request – invalid or missing key, invalid account UUID, or missing/invalid topup value
  • 402 Payment Required – not enough organization credits available to perform this topup
  • 404 Not Found – account not found or already deleted

Messaging Plus is a Cymba API