Update an application

Beta

PATCH

/v2/requests/:requestsReference

PATCH

/api/v2/requests/:requestsReference

curl -X PATCH https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "externalId": "APP-2025-0417-REV2",
  "tags": [
    "priority",
    "expedited"
  ]
}'

{
  "success": true,
  "message": "Application updated successfully",
  "traceId": "0HNNNPRPLVN3H:00000011",
  "data": {
    "requestsReference": "3f3caa7b-bdfe-4bf1-814b-30d54859247c",
    "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
    "applicationStatus": "draft",
    "applicationStatusCode": 1,
    "allowedActions": [
      "submit",
      "withdraw",
      "abandon"
    ],
    "createdAt": "2026-07-01T15:00:01.734346",
    "_links": {
      "self": "/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c",
      "business": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
    },
    "paypointReference": "019ff064-c690-7679-a73e-688418aadc7c",
    "paypointStatus": "pending",
    "externalId": "APP-2025-0417-REV2",
    "tags": [
      "priority",
      "expedited"
    ]
  }
}

Applies a partial update to a boarding application. Send only the fields you want to change.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

requestsReferencestringRequired

The application reference.

Request

This endpoint expects an object.

externalIdstringOptional

An optional identifier from your own system.

entityTypestringOptional

The type of entity being boarded.

requestTemplatestringOptional

The reference of the boarding template to apply.

tagslist of stringsOptional

Optional labels for the application.

representativeslist of objectsOptional

The sales or service representatives assigned to the application.

configurationsobject or nullOptional

Opaque application-level configuration.

servicesobjectOptional

The services to request on the application. Replaces the whole services object, so send every service you want to keep. Leave it out to keep the current services.

Response

The updated application.

successboolean

Whether the request succeeded.

messagestring or null

A human-readable result message.

traceIdstring or null

The trace identifier for the request, useful for support.

dataobject or null

The application.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error