Invite a User
Invites a new user to your Fivetran account. The invited user will have access to the account only after accepting the invitation. Invited user details are still accessible through the API.
Request schema
Header parameters
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Request
The email address that the user has associated with their user profile.
The last name of the user.
The first name of the user.
The phone number of the user.
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==')
The role that you would like to assign to the user
POST /v1/users HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 226
{
"email": "user@email.value",
"family_name": "Doe",
"given_name": "John",
"phone": "+1234567890",
"picture": "AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==",
"role": "Account Administrator"
}Responses
Successful response schema
Response status code
Response status text
The unique identifier for the user within the Fivetran system.
The email address that the user has associated with their user profile.
The field indicates whether the user has verified their email address in the account creation process.
The field indicates whether the user has been invited to your account.
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==')
The phone number of the user.
The role that you would like to assign to the user
The field indicates if the user is an active Fivetran account user.
The first name of the user.
The timestamp that the user created their Fivetran account
The last name of the user.
The last time that the user has logged into their Fivetran account.
{
"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"
}
}