User change requests

Retrieve and process pending user change requests for attributes configured with admin approval.

The public API URLs documented here are exposed by the API Gateway. Internally, the Symfony application serves these endpoints behind the /public/api prefix.

List pending change requests

GET https://api.signitic.app/user-change-requests

Headers

Name	Type	Description
x-api-key*	String	Your API key

200 OK

{
  "success": true,
  "code": 200,
  "data": [
    {
      "email": "[email protected]",
      "display_name": "John Doe",
      "change_requests": [
        {
          "field": "phone",
          "old_value": "0102030405",
          "new_value": "0607080910",
          "status": "pending"
        },
        {
          "field": "title",
          "old_value": "Sales",
          "new_value": "Head of Sales",
          "status": "pending"
        }
      ]
    }
  ]
}

Get one user's pending change requests

GET https://api.signitic.app/user-change-requests/:email

Headers

Name	Type	Description
x-api-key*	String	Your API key

Path Parameters

Name	Type	Description
email*	String	User email

200 OK

{
  "success": true,
  "code": 200,
  "data": {
    "email": "[email protected]",
    "display_name": "John Doe",
    "change_requests": [
      {
        "field": "phone",
        "old_value": "0102030405",
        "new_value": "0607080910",
        "status": "pending"
      }
    ]
  }
}

Approve one pending change request

PATCH https://api.signitic.app/user-change-requests/:email/:field

Headers

Name	Type	Description
x-api-key*	String	Your API key

Path Parameters

Name	Type	Description
email*	String	User email
field*	String	Requested field slug

No request body is required.

200 OK

{
  "success": true,
  "code": 200,
  "data": {
    "operation": "approved",
    "field": "phone",
    "user": {
      "email": "[email protected]",
      "display_name": "John Doe",
      "change_requests": []
    }
  }
}

Reject one pending change request

DELETE https://api.signitic.app/user-change-requests/:email/:field

Headers

Name	Type	Description
x-api-key*	String	Your API key

Path Parameters

Name	Type	Description
email*	String	User email
field*	String	Requested field slug

No request body is required.

200 OK

{
  "success": true,
  "code": 200,
  "data": {
    "operation": "rejected",
    "field": "phone",
    "user": {
      "email": "[email protected]",
      "display_name": "John Doe",
      "change_requests": []
    }
  }
}

Common errors

Status	Description
200	{"success": false, "code": 99, "message": "Invalid API key."} when the API key is missing or invalid.
200	{"success": false, "code": 101, "message": "Invalid email."} when the email is invalid or does not match a user in the workspace.
200	{"success": false, "code": 104, "message": "Change request not found."} when the field is not pending for the target user.