PUT
/
v1
/
provider
/
update
/
{provider_id}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

provider_id
string
required

Body

application/json
address
string | null
addressLineTwo
string | null
addressValid
boolean | null
city
string | null
country
string | null
email
string | null
externalUserId
string | null
firstName
string | null
lastName
string | null
meta
object | null
phoneNumber
string | null
roles
string[] | null

List of roles associated with the provider.

state
string | null
type
string | null
updatedDate
string
zipCode
string | null

Response

200 - application/json
createdDate
string
required

The date and time when the user was created.

firstName
string
required

The user's first name.

id
string
required

The unique identifier for the user.

roles
object[]
required

List of roles associated with the provider.

type
string
required

Type of the user, fixed as 'provider'.

address
string | null

The user's primary address.

addressLineTwo
string | null

Additional address information.

addressValid
boolean | null

Whether the user's address is valid.

city
string | null

The city of the user's address.

country
string | null

The country of the user's address.

email
string | null

The user's email address.

externalUserId
string | null

The user's external identifier if available.

lastName
string | null

The user's last name.

meta
object | null

Any additional metadata about the user relevant to your system.

phoneNumber
string | null

The user's phone number.

state
string | null

The state of the user's address.

zipCode
string | null

The postal code of the user's address.