Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-1352108391.8 KB
Users

Create user

Create user

post/crm/users

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

idstring

The unique identifier for the user

parent_idstring nullable

The parent user id

usernamestring nullable

The username of the user

namestring nullable

The name of the resource.

first_namestring nullable

The first name of the person.

last_namestring nullable

The last name of the person.

titlestring nullable

The job title of the person.

divisionstring nullable

The division the person is currently in. Usually a collection of departments or teams or regions.

departmentstring nullable

The department the person is currently in. Deprecated in favor of the dedicated department_id and department_name field.

company_namestring nullable

The name of the company.

employee_numberstring nullable

An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.

descriptionstring nullable

A description of the object.

imagestring nullable

The URL of the user's avatar

languagestring nullable

language code according to ISO 639-1. For the United States - EN

statusstring nullable

The status of the user

passwordstring nullable

The password of the user

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

updated_atstring nullable

The date and time when the user was last updated.

created_atstring nullable

The date and time when the user was created.

Example request

{
  "id": "12345",
  "parent_id": "54321",
  "username": "masterofcoin",
  "name": "Acme Inc.",
  "first_name": "Elon",
  "last_name": "Musk",
  "title": "CEO",
  "division": "Europe",
  "department": "R&D",
  "company_name": "SpaceX",
  "employee_number": "123456-AB",
  "description": "A description",
  "image": "https://logo.clearbit.com/spacex.com?s=128",
  "language": "EN",
  "status": "active",
  "password": "supersecretpassword",
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "line5": "Attention: Finance Dept",
      "street_number": "25",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638",
      "county": "Santa Clara",
      "contact_name": "Elon Musk",
      "salutation": "Mr",
      "phone_number": "111-111-1111",
      "fax": "122-111-1111",
      "email": "elon@musk.com",
      "website": "https://elonmusk.com",
      "notes": "Address notes or delivery instructions.",
      "row_version": "1-12345"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "updated_at": "2017-08-12T20:43:21.291Z",
  "created_at": "2017-08-12T20:43:21.291Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

User created

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "users",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}