HEhellozai
Callbacks

Update Callback

Update an existing Callback using a given :id. You can change the URL, the object_type and whether the Callback is enabled or disabled.

patch/callbacks/{id}

Request

  • Base URL
    https://test.api.promisepay.com
  • URL
    https://test.api.promisepay.com/callbacks/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://au-0000.sandbox.auth.assemblypay.com/tokens

Path parameters

idstring required

Callback ID

Request body

urlstring required

URL to which the callbacks will notify

object_typestring required

Object or entity to which the callbacks refer. Please refer to Callbacks for a list of object types.

enabledstring required

Toggle whether callback is active or inactive.

Example request

{
  "url": "https://httpbin.org",
  "object_type": "users",
  "enabled": "true"
}

Response

OK

Example response

{
  "callbacks": {
    "id": "f92d4ca1-4ee5-43f3-9e34-ca5f759c5e76",
    "description": "Users Callback",
    "url": "https://httpbin.org/post",
    "object_type": "users",
    "enabled": true
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.