POST /users — fragment-payments-api

Users

Creates a user.

post/users

Request body

external_idstring required

User-provided unique ID.

Example request

{
  "external_id": "user_ext_123",
  "tags": [
    {
      "key": "department",
      "value": "engineering"
    }
  ]
}

Response

Success

Example response

{
  "data": {
    "id": "user_abc123",
    "external_id": "user_ext_123",
    "tags": [
      {
        "key": "department",
        "value": "engineering"
      }
    ]
  }
}

Changes

Changed in 6 of the 38 revisions of this API.3212

May 11, 202691a072ddf86d11See the full diff
- ▲
  removed the required property data/role from the response with the 201 status
  response-required-property-removed
- ●
  removed the request property role
  request-property-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 23, 20262313a4acc2415See the full diff
- ○
  added the new optional request property tags
  new-optional-request-property
- ○
  the request property role became optional
  request-property-became-optional
- ○
  request property role deprecated
  request-property-deprecated
- ○
  response property data/role deprecated
  response-property-deprecated
- ○
  added the required property data/tags to the response with the 201 status
  response-required-property-added
Mar 13, 2026dd22ecbbe8e521See the full diff
- ▲
  the request property external_id became required
  request-property-became-required
- ▲
  removed the required property data/externalId from the response with the 201 status
  response-required-property-removed
- ●
  removed the request property externalId
  request-property-removed
Mar 6, 20266768d46dbde85See the full diff
- ○
  added the new optional request property external_id
  new-optional-request-property
- ○
  the request property externalId became optional
  request-property-became-optional
- ○
  request property externalId deprecated
  request-property-deprecated
- ○
  response property data/externalId deprecated
  response-property-deprecated
- ○
  added the required property data/external_id to the response with the 201 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 5, 2026635b1d55b7351See the full diff
- ○
  added the required property data/id to the response with the 201 status
  response-required-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 2, 20260f4bb2a098cb1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history