Update a User

PUT 
/users/:id

Deprecation Notice

API v1 will be deprecated on January 31, 2026.
API v2 will be deprecated on February 28, 2026.
Please migrate to API v3 as soon as possible.

The "Update a User" section allows users to modify the details of a specific user within the Agility Credit system. By providing new information such as first name, last name, email, and phone number, users can easily update user profiles. This section enables seamless management of user data for improved accuracy and relevance within the platform.

Request

Path Parameters

id stringrequired

ID of the user to be updated

Header Parameters

Agc-Tenant-Id stringrequired

The tenant ID provided by Agility Credit.

Agc-User-Id stringrequired

The requestor user ID.

Idempotency-Key stringrequired

A unique, idempotent key. We recommend to use a guid

application/json

Body

required

Inquiry request payload

user_idstringrequired
first_namestring
last_namestring
emailstring
phone_numberstring

Responses

200

User updated successfully

application/json

Schema

Schema

user_iduuidrequired

The unique identifier for the user.

created_atdate-timerequired

The timestamp when the user was created.

emailemailrequired

The email address of the user.

first_namestringrequired

The first name of the user.

last_namestringrequired

The last name of the user.

phonestringrequired

The phone number of the user.

updated_atdate-timerequired

The timestamp when the user was last updated.

Example (from schema)

{
  "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2024-07-29T15:51:28.071Z",
  "email": "user@example.com",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "updated_at": "2024-07-29T15:51:28.071Z"
}

400

Bad Request

application/json

Schema

Schema

statusstring
errorstring

Example (from schema)

{
  "status": "Bad Request - Invalid Parameters",
  "error": "Failed schema validation. Error: data.pull_type must be one of ['prequal', 'hard'], Path: ['data', 'pull_type'], Data: prequalification"
}

401

Unauthorized

application/json

Schema

Schema

messagestring

Example (from schema)

{
  "message": "Unauthorized"
}

429

Too Many Requests

application/json

Schema

Schema

errorstring

Example (from schema)

{
  "error": "Too Many Requests"
}

500

Internal Server Error

application/json

Schema

Schema

messagestring

Example (from schema)

{
  "message": "Agility Server Error"
}