Update a User

Updates information for an existing user within your Fivetran account.

Request schema

Path parameters

userId

stringrequired

The unique identifier for the user within the account.

example:

user_id

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Request

phone

string

The phone number of the user.

example:

+9876543210

picture

string

The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')

example:

AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==

role

string

The role that you would like to assign to the user

example:

Account Administrator

family_name

string

The last name of the user.

example:

Doe

given_name

string

The first name of the user.

example:

Jane

Http + 1.1

PATCH

https://api.fivetran.com/v1/users/user_id

PATCH /v1/users/user_id HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 195

{
  "phone": "+9876543210",
  "picture": "AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==",
  "role": "Account Administrator",
  "family_name": "Doe",
  "given_name": "Jane"
}

Responses

200

Successful response

404

User not found

Successful response schema

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed.

data

objectrequired

stringrequired

The unique identifier for the user within the Fivetran system.

example:

user_id

stringrequired

The email address that the user has associated with their user profile.

example:

user@email.value

verified

booleanrequired

The field indicates whether the user has verified their email address in the account creation process.

example:

true

invited

boolean

The field indicates whether the user has been invited to your account.

example:

true

picture

string

example:

AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==

phone

string

The phone number of the user.

example:

+1234567890

role

stringrequired

The role that you would like to assign to the user

example:

Account Administrator

active

booleanrequired

The field indicates if the user is an active Fivetran account user.

example:

true

given_name

string

The first name of the user.

example:

John

created_at

stringrequired

The timestamp that the user created their Fivetran account

format:

date-time

example:

2024-01-01T00:00:00Z

family_name

string

The last name of the user.

example:

Doe

logged_in_at

stringrequired

The last time that the user has logged into their Fivetran account.

format:

date-time

example:

2024-01-01T00:00:00Z

{
  "code": "Success",
  "message": "Operation performed.",
  "data": {
    "id": "user_id",
    "email": "user@email.value",
    "verified": true,
    "invited": true,
    "picture": "AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==",
    "phone": "+1234567890",
    "role": "Account Administrator",
    "active": true,
    "given_name": "John",
    "created_at": "2024-01-01T00:00:00Z",
    "family_name": "Doe",
    "logged_in_at": "2024-01-01T00:00:00Z"
  }
}