Users

Create user

Description of levels: 1 for Basic, 2 for Manager, 3 for Executive. The non-name-related values shown are the defaults. Basic users and Managers must belong to a team, so when creating either a basic user or a manager, you have to include a team_id property. Adding a team_id field will assign those users to a given team. Executive users cannot belong to a team, thus team_id property is not applicable.

post/admin/users

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/admin/users
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header app-key
    • API key in query parameter api_key and API key in query parameter app_key

Request body

Example request

{
  "user": {
    "id": 13,
    "full_name": "Sam Okafor"
  }
}

Response

Successful Response

idinteger

Unique identifier

account_idinteger

Account ID of the user

full_namestring

Full name of the user

api_keystring

The api key of the user. You can use this api key to perform requests using our api.

last_seen_atstring nullable

Timestamp of when the user was last logged in

deleted_atstring nullable

Timestamp when user was deleted (if inactive)

mfa_requested_atstring nullable

Timestamp when user requested multi-factor authentication

data_reassigned_atstring nullable

Timestamp when data was reassigned

reassign_data_to_user_idinteger

User ID to reassign data to when deleting a user. If not specified, the data owned by the deleted user will be reassigned to the account admin making the request.

w2lidstring

The web-to-lead ID of the user. You can use this ID to setup web-to-leads forms.

created_atstring

Timestamp when the record was created (time zone in user's time zone).

updated_atstring

Timestamp when the record was last touched (time zone in user's time zone).

manager_idinteger nullable

Returns the user_id of this user's manager. (obsolete)

team_idinteger nullable

Returns the team_id of this user.

emailstring

Email address of the user

levelinteger

Level of the user

namestring

Username

first_namestring

The first name of the user

last_namestring

The last name of the user

is_account_adminboolean

Whether or not the user is an account admin.

avatar_thumb_urlstring nullable

The avatar thumbnail URL

mobile_numberstring nullable

Mobile number of the user

date_formatstring

Date format of the user

time_formatstring

Time format of the user

is_allowed_to_exportboolean

Is user allowed to export

is_allowed_to_deleteboolean

Is user allowed to delete

is_allowed_to_send_campaignsboolean

Is user allowed to send campaigns

is_allowed_to_merge_recordsboolean

Is user allowed to merge records

is_google_apps_enabledboolean
read_onlyboolean

Is user read only

mfa_enabledboolean

Is multi-factor authentication enabled for this user

phone_number_display_format'national' | 'dashed' | 'spaces' | 'null' nullable

The user's phone number display preference; null inherits the account default

csv_column_separatorstring

CSV column separator

csv_decimal_markstring

CSV decimal mark

pipeline_email_clientboolean

Use Pipeline email client for links

time_zonestring

The timezone identifier for the user (as defined by <a href="http://www.iana.org/time-zones" target="_blank">IANA</a>).

Example response

{
  "id": 13,
  "account_id": 1234,
  "full_name": "Sam Okafor",
  "api_key": "abcd1234",
  "last_seen_at": "2018/05/02 12:35:05 -0700",
  "deleted_at": "2018/05/02 12:35:05 -0700",
  "mfa_requested_at": "2018/05/02 12:35:05 -0700",
  "data_reassigned_at": "2018/05/02 12:35:05 -0700",
  "reassign_data_to_user_id": 1234,
  "w2lid": "abcd1234",
  "other_emails": [
    {
      "id": 1,
      "email": "bob@smith.com"
    }
  ],
  "created_at": "2026-09-01 14:22:07",
  "updated_at": "2026-09-01 14:22:07",
  "manager_id": 1234,
  "team_id": 1234,
  "email": "sam.okafor@northwind.example",
  "level": 2,
  "name": "Sam Okafor",
  "first_name": "Sam",
  "last_name": "Okafor",
  "avatar_thumb_url": "https://s3.amazonaws.com/pipelinedeals/avatars/1234/thumb/wolverine-avatar.png",
  "mobile_number": "123-456-7890",
  "date_format": "us",
  "time_format": "US",
  "is_allowed_to_export": true,
  "is_allowed_to_merge_records": true,
  "phone_number_display_format": "national",
  "currency": {
    "id": 1,
    "name": "US Dollar",
    "code": "USD",
    "symbol": "$"
  },
  "csv_column_separator": ",",
  "csv_decimal_mark": ".",
  "time_zone": "America/New_York"
}

Changes

No recorded changes to this operation across all 1 revision of this API.