Hivebrite Admin API

Swagger documentation for the Hivebrite Admin API

oauth

Operations about oauths

POST /api/oauth/token
Requests
Body
{
  "grant_type": "Hello, world!",
  "scope": "Hello, world!",
  "admin_email": "Hello, world!",
  "password": "Hello, world!",
  "client_id": "Hello, world!",
  "client_secret": "Hello, world!",
  "refresh_token": "Hello, world!",
  "redirect_uri": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "grant_type": {
      "type": "string"
    },
    "scope": {
      "type": "string"
    },
    "admin_email": {
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "client_id": {
      "type": "string"
    },
    "client_secret": {
      "type": "string"
    },
    "refresh_token": {
      "type": "string"
    },
    "redirect_uri": {
      "type": "string",
      "default": "urn:ietf:wg:oauth:2.0:oob"
    }
  },
  "required": [
    "grant_type",
    "scope"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses201

OAuth2 Authentication

OAuth2 Authentication
POST/api/oauth/token

Use grant_type password to get your access token, using params:

  • admin_email

  • password

  • client_id

  • client_secret

Or

Use grant_type refresh_token to get a new access token, using params:

  • refresh_token

me

Operations about mes

GET /api/admin/v1/me
Responses200

Get information about the current admin

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "email": {
      "type": "string",
      "description": "Admin email"
    },
    "name": {
      "type": "string",
      "description": "Admin full name"
    },
    "admin_type": {
      "type": "string",
      "enum": [
        "global",
        "group"
      ],
      "description": "Admin type"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Admin creation  date"
    }
  },
  "description": "Admin model"
}

Get information about the current admin
GET/api/admin/v1/me

Current admin is the owner of the access_token used in the request.


settings

Operations about settings

GET /api/admin/v1/settings/currencies
Responses200

Get Network Currencies

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "name": {
      "type": "string",
      "description": "Currency name"
    },
    "code": {
      "type": "string",
      "description": "Currency code"
    },
    "symbol": {
      "type": "string",
      "description": "Currency symbol"
    }
  },
  "description": "Currency model"
}

Get Network Currencies
GET/api/admin/v1/settings/currencies

Return this network enabled currencies.


GET /api/admin/v1/settings/job_functions
Responses200

Get all job functions

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "identifier": {
      "type": "string",
      "description": "Job function name"
    }
  },
  "description": "JobFunction model"
}

Get all job functions
GET/api/admin/v1/settings/job_functions

Return this network job functions.


GET /api/admin/v1/settings/industries
Responses200

Get all industries

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "name": {
      "type": "string",
      "description": "Industry name"
    }
  },
  "description": "IndustryStudy model"
}

Get all industries
GET/api/admin/v1/settings/industries

Return this network industries.


POST /api/admin/v1/settings/field_of_studies
Requests
Body
{
  "field_of_study[name]": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "field_of_study[name]": {
      "type": "string",
      "description": "Name of the field of study"
    }
  },
  "required": [
    "field_of_study[name]"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses201

Create a field of study

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "name": {
      "type": "string",
      "description": "Field of study name"
    }
  },
  "description": "FieldOfStudy model"
}

Create a field of study
POST/api/admin/v1/settings/field_of_studies

Return the created field of study if none with the same name exists. Returns the existing field of study otherwise


GET /api/admin/v1/settings/field_of_studies
Responses200

Get all field of studies

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "name": {
      "type": "string",
      "description": "Field of study name"
    }
  },
  "description": "FieldOfStudy model"
}

Get all field of studies
GET/api/admin/v1/settings/field_of_studies

Return this network field of studies.


GET /api/admin/v1/settings/customizable_attributes
Responses200

Get all customizable attributes

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "customizable_id": {
      "type": "integer",
      "format": "int32",
      "description": "Customizable ID"
    },
    "type": {
      "type": "string",
      "enum": [
        "CustomizableAttribute::Text",
        "CustomizableAttribute::Boolean",
        "CustomizableAttribute::Date",
        "CustomizableAttribute::Number",
        "CustomizableAttribute::Select",
        "CustomizableAttribute::DoubleSelect"
      ],
      "description": "Customizable Attribute type"
    },
    "customizable_type": {
      "type": "string",
      "enum": [
        "user",
        "experience",
        "education",
        "event_addon",
        "ne_event",
        "ne_ticket",
        "ventures_venture",
        "bizopp",
        "bizopp_kind_config",
        "topic_approval",
        "donation",
        "donation_campaign",
        "donation_user",
        "memberships_topic",
        "memberships_user"
      ],
      "description": "Customizable Attribute associated model (User, Experience)"
    },
    "name": {
      "type": "string",
      "description": "Customizable Attribute name"
    },
    "display_name": {
      "type": "string",
      "description": "Customizable Attribute displayed name"
    },
    "tooltip": {
      "type": "string",
      "description": "Customizable Attribute tooltip"
    },
    "placeholder": {
      "type": "string",
      "description": "Customizable Attribute placeholder"
    },
    "multi": {
      "type": "boolean",
      "description": "Customizable Attribute multi activated ?"
    },
    "text_size": {
      "type": "integer",
      "format": "int32",
      "description": "Customizable Attribute text_size"
    },
    "visibility": {
      "type": "string",
      "description": "Customizable Attribute visibility"
    },
    "user_editable": {
      "type": "boolean",
      "description": "Customizable Attribute editable by the user ?"
    },
    "required": {
      "type": "boolean",
      "description": "Customizable Attribute required ?"
    },
    "options": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Customizable Attribute array of options"
    },
    "json_options": {
      "type": "object",
      "description": "Customizable Attribute json options (for double select)"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Customizable Attribute creation date"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Customizable Attribute last update date"
    }
  },
  "description": "CustomizableAttribute model"
}

Get all customizable attributes
GET/api/admin/v1/settings/customizable_attributes

Return this network customizable attributes.

URI Parameters
customized_type
string (required) 
customized_id
string (required) 

GET /api/admin/v1/settings/zapier/customizable_attributes/educations
Responses200

Get all education customizable attributes (for Zapier)

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Customizable Attribute unique identifier"
    },
    "type": {
      "type": "string",
      "description": "Customizable Attribute Zapier type"
    },
    "key": {
      "type": "string",
      "description": "Customizable Attribute name"
    },
    "required": {
      "type": "boolean",
      "description": "Customizable Attribute required ?"
    },
    "label": {
      "type": "string",
      "description": "Customizable Attribute label"
    },
    "help_text": {
      "type": "string",
      "description": "Customizable Attribute help text"
    },
    "choices": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Available values for Customizable Attribute"
    },
    "list": {
      "type": "boolean",
      "description": "Customizable Attribute accept multiple values"
    }
  },
  "description": "CustomizableAttributeZapier model"
}

Get all education customizable attributes (for Zapier)
GET/api/admin/v1/settings/zapier/customizable_attributes/educations

Return this network customizable attributes for Education in a zapier-compatible format


GET /api/admin/v1/settings/zapier/customizable_attributes/experiences
Responses200

Get all experience customizable attributes (for Zapier)

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Customizable Attribute unique identifier"
    },
    "type": {
      "type": "string",
      "description": "Customizable Attribute Zapier type"
    },
    "key": {
      "type": "string",
      "description": "Customizable Attribute name"
    },
    "required": {
      "type": "boolean",
      "description": "Customizable Attribute required ?"
    },
    "label": {
      "type": "string",
      "description": "Customizable Attribute label"
    },
    "help_text": {
      "type": "string",
      "description": "Customizable Attribute help text"
    },
    "choices": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Available values for Customizable Attribute"
    },
    "list": {
      "type": "boolean",
      "description": "Customizable Attribute accept multiple values"
    }
  },
  "description": "CustomizableAttributeZapier model"
}

Get all experience customizable attributes (for Zapier)
GET/api/admin/v1/settings/zapier/customizable_attributes/experiences

Return this network customizable attributes for Experience in a zapier-compatible format


GET /api/admin/v1/settings/zapier/customizable_attributes/users
Responses200

Get all user customizable attributes (for Zapier)

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Customizable Attribute unique identifier"
    },
    "type": {
      "type": "string",
      "description": "Customizable Attribute Zapier type"
    },
    "key": {
      "type": "string",
      "description": "Customizable Attribute name"
    },
    "required": {
      "type": "boolean",
      "description": "Customizable Attribute required ?"
    },
    "label": {
      "type": "string",
      "description": "Customizable Attribute label"
    },
    "help_text": {
      "type": "string",
      "description": "Customizable Attribute help text"
    },
    "choices": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Available values for Customizable Attribute"
    },
    "list": {
      "type": "boolean",
      "description": "Customizable Attribute accept multiple values"
    }
  },
  "description": "CustomizableAttributeZapier model"
}

Get all user customizable attributes (for Zapier)
GET/api/admin/v1/settings/zapier/customizable_attributes/users

Return this network customizable attributes for User in a zapier-compatible format


network

Operations about networks

GET /api/admin/v1/network
Responses200

Get network information

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "title": {
      "type": "string",
      "description": "Sub Network title"
    },
    "sub_networks": {
      "description": "Sub Networks list",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "title": {
          "type": "string",
          "description": "Sub Network title"
        }
      }
    },
    "user_lists": {
      "description": "User lists",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "title": {
          "type": "string",
          "description": "List title"
        },
        "description": {
          "type": "string",
          "description": "List description"
        },
        "user_count": {
          "type": "integer",
          "format": "int32",
          "description": "Number of users part of the list"
        }
      }
    }
  },
  "required": [
    "title",
    "sub_networks",
    "user_lists"
  ],
  "description": "Network model"
}

Get network information
GET/api/admin/v1/network

Return this network information.


DELETE /api/admin/v1/network/sub_networks/id
Responses204

Delete a new sub network

Delete a new sub network
DELETE/api/admin/v1/network/sub_networks/{id}

Delete a sub network

URI Parameters
id
string (required) 

PUT /api/admin/v1/network/sub_networks/id
Requests
Body
{
  "sub_network[title]": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "sub_network[title]": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200

Update a sub network

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "title": {
      "type": "string",
      "description": "Sub Network title"
    }
  },
  "description": "SubNetwork model"
}

Update a sub network
PUT/api/admin/v1/network/sub_networks/{id}

Return the updated sub network

URI Parameters
id
string (required) 

POST /api/admin/v1/network/sub_networks
Requests
Body
{
  "title": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "title": {
      "type": "string"
    }
  },
  "required": [
    "title"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses201

Add a new sub network

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "title": {
      "type": "string",
      "description": "Sub Network title"
    }
  },
  "description": "SubNetwork model"
}

Add a new sub network
POST/api/admin/v1/network/sub_networks

Return the created sub network


GET /api/admin/v1/network/citizenships
Responses200

List all citizenships

Schema
{
  "type": "object",
  "properties": {
    "citizenships": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique ID"
          },
          "name": {
            "type": "string",
            "description": "Country"
          },
          "code": {
            "type": "string",
            "description": "Country code ISO Alpha 2"
          }
        }
      }
    }
  },
  "description": "Nationalities model"
}

List all citizenships
GET/api/admin/v1/network/citizenships

Return all citizenships


experiences

Operations about experiences

DELETE /api/admin/v1/experiences/id?experience_key=
Responses204

Delete User experience

Delete User experience
DELETE/api/admin/v1/experiences/{id}{?experience_key}

Delete the user experience based on its ID

Use `external_id` as the **experience_key** parameter to identify the experience instead of default experience ID.
URI Parameters
id
string (required) 
experience_key
string (required) 

PUT /api/admin/v1/experiences/id
Requests
Body
{
  "experience_key": "Hello, world!",
  "experience[companies_company_key]": "Hello, world!",
  "experience[position]": "Hello, world!",
  "experience[from]": "Hello, world!",
  "experience[to]": "Hello, world!",
  "experience[companies_company_id]": "Hello, world!",
  "experience[custom_attributes]": [],
  "experience[industry_id]": 1,
  "experience[job_function_id]": 1,
  "experience[external_id]": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "experience_key": {
      "type": "string"
    },
    "experience[companies_company_key]": {
      "type": "string"
    },
    "experience[position]": {
      "type": "string",
      "description": "Experience position"
    },
    "experience[from]": {
      "type": "string",
      "description": "Experience started at"
    },
    "experience[to]": {
      "type": "string",
      "description": "Experience ended at"
    },
    "experience[companies_company_id]": {
      "type": "string",
      "description": "ID of company linked"
    },
    "experience[custom_attributes]": {
      "type": "array",
      "description": "Array of customizable attributes with name, value and type\n\n+"
    },
    "experience[industry_id]": {
      "type": "number",
      "description": "Industry ID matching the experience"
    },
    "experience[job_function_id]": {
      "type": "number",
      "description": "Job Function ID matching the experience"
    },
    "experience[external_id]": {
      "type": "string",
      "description": "Experience ID in your database"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200422

Update existing user experience

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "position": {
      "type": "string",
      "description": "Experience position"
    },
    "from": {
      "type": "string",
      "format": "date",
      "description": "Experience started at"
    },
    "to": {
      "type": "string",
      "format": "date",
      "description": "Experience ended at"
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Array of customizable attributes with name, value and type"
    },
    "external_id": {
      "type": "string",
      "description": "Experience ID in your database"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience creation date"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience last update date time - iso8601"
    },
    "user_id": {
      "type": "integer",
      "format": "int32",
      "description": "User linked to experience"
    },
    "industry": {
      "description": "Industry linked to Experience",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "name": {
          "type": "string",
          "description": "Industry name"
        }
      }
    },
    "job_function": {
      "description": "Job Function linked to Experience",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "identifier": {
          "type": "string",
          "description": "Job function name"
        }
      }
    },
    "company": {
      "description": "Company linked to Experience",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "name": {
          "type": "string",
          "description": "Company full name"
        }
      }
    },
    "extended_updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience (including custom attributes) last update date time - iso8601"
    }
  },
  "description": "Experience model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Update existing user experience
PUT/api/admin/v1/experiences/{id}

Update a user experience

Find the user experience matching its ID, or use external_id as the experience_key parameter to identify the experience instead of default ID.

URI Parameters
id
string (required) 

Experience ID


GET /api/admin/v1/experiences/id?experience_key=
Responses200

Get user experience

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "position": {
      "type": "string",
      "description": "Experience position"
    },
    "from": {
      "type": "string",
      "format": "date",
      "description": "Experience started at"
    },
    "to": {
      "type": "string",
      "format": "date",
      "description": "Experience ended at"
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Array of customizable attributes with name, value and type"
    },
    "external_id": {
      "type": "string",
      "description": "Experience ID in your database"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience creation date"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience last update date time - iso8601"
    },
    "user_id": {
      "type": "integer",
      "format": "int32",
      "description": "User linked to experience"
    },
    "industry": {
      "description": "Industry linked to Experience",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "name": {
          "type": "string",
          "description": "Industry name"
        }
      }
    },
    "job_function": {
      "description": "Job Function linked to Experience",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "identifier": {
          "type": "string",
          "description": "Job function name"
        }
      }
    },
    "company": {
      "description": "Company linked to Experience",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "name": {
          "type": "string",
          "description": "Company full name"
        }
      }
    },
    "extended_updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience (including custom attributes) last update date time - iso8601"
    }
  },
  "description": "Experience model"
}

Get user experience
GET/api/admin/v1/experiences/{id}{?experience_key}

Return the user experience based on its ID

Find the user experience matching its ID, or use external_id as the experience_key parameter to identify the experience on one of these identifier instead of default ID.

URI Parameters
experience_key
string (required) 
id
number (required) 

GET /api/admin/v1/experiences
Responses200

Get all experiences

Schema
{
  "type": "object",
  "properties": {
    "experiences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique ID"
          },
          "position": {
            "type": "string",
            "description": "Experience position"
          },
          "from": {
            "type": "string",
            "format": "date",
            "description": "Experience started at"
          },
          "to": {
            "type": "string",
            "format": "date",
            "description": "Experience ended at"
          },
          "custom_attributes": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Array of customizable attributes with name, value and type"
          },
          "external_id": {
            "type": "string",
            "description": "Experience ID in your database"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Experience creation date"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Experience last update date time - iso8601"
          },
          "user_id": {
            "type": "integer",
            "format": "int32",
            "description": "User linked to experience"
          },
          "industry": {
            "description": "Industry linked to Experience",
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "format": "int32",
                "description": "Unique ID"
              },
              "name": {
                "type": "string",
                "description": "Industry name"
              }
            }
          },
          "job_function": {
            "description": "Job Function linked to Experience",
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "format": "int32",
                "description": "Unique ID"
              },
              "identifier": {
                "type": "string",
                "description": "Job function name"
              }
            }
          },
          "company": {
            "description": "Company linked to Experience",
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "format": "int32",
                "description": "Unique ID"
              },
              "name": {
                "type": "string",
                "description": "Company full name"
              }
            }
          },
          "extended_updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Experience (including custom attributes) last update date time - iso8601"
          }
        },
        "description": "Experience model"
      }
    }
  },
  "description": "ExperiencesFull model"
}

Get all experiences
GET/api/admin/v1/experiences

Return an array of experiences with basic information

Use the param updated_since to fetch all experiences updated since this datetime (e.g. updated_since=2017-08-01T00:00:00)

Use the param order to choose on which criterias the results should be ordered (e.g. order=updated_at to order by updated_at descending, use the minus operator to order by ascending value e.g. order=-updated_at).

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/experiences?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/experiences?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/experiences?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/experiences?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
URI Parameters
order
string (required) 
updated_since
string (required) 
page
string (required) 

Page of results to fetch.

per_page
string (required) 

Number of results to return per page.


users

Operations about users

DELETE /api/admin/v1/users/user_id/experiences/id?key=&experience_key=
Responses204

Delete User experience

Delete User experience
DELETE/api/admin/v1/users/{user_id}/experiences/{id}{?key,experience_key}

Delete the user experience based on its ID and the associated user ID

Use `external_id` or `previous_id` as the **key** parameter to identify the user on one of these identifier instead of default user ID.
URI Parameters
key
string (required) 
id
string (required) 
experience_key
string (required) 
user_id
number (required) 

PUT /api/admin/v1/users/user_id/experiences/id
Requests
Body
{
  "key": "Hello, world!",
  "experience_key": "Hello, world!",
  "experience[companies_company_key]": "Hello, world!",
  "experience[position]": "Hello, world!",
  "experience[from]": "Hello, world!",
  "experience[to]": "Hello, world!",
  "experience[companies_company_id]": "Hello, world!",
  "experience[custom_attributes]": [],
  "experience[industry_id]": 1,
  "experience[job_function_id]": 1,
  "experience[external_id]": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "experience_key": {
      "type": "string"
    },
    "experience[companies_company_key]": {
      "type": "string"
    },
    "experience[position]": {
      "type": "string",
      "description": "Experience position"
    },
    "experience[from]": {
      "type": "string",
      "description": "Experience started at"
    },
    "experience[to]": {
      "type": "string",
      "description": "Experience ended at"
    },
    "experience[companies_company_id]": {
      "type": "string",
      "description": "ID of company linked"
    },
    "experience[custom_attributes]": {
      "type": "array",
      "description": "Array of customizable attributes with name, value and type\n\n+"
    },
    "experience[industry_id]": {
      "type": "number",
      "description": "Industry ID matching the experience"
    },
    "experience[job_function_id]": {
      "type": "number",
      "description": "Job Function ID matching the experience"
    },
    "experience[external_id]": {
      "type": "string",
      "description": "Experience ID in your database"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200422

Update existing user experience

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "position": {
      "type": "string",
      "description": "Experience position"
    },
    "from": {
      "type": "string",
      "format": "date",
      "description": "Experience started at"
    },
    "to": {
      "type": "string",
      "format": "date",
      "description": "Experience ended at"
    },
    "companies_company_id": {
      "type": "string",
      "description": "ID of company linked"
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Array of customizable attributes with name, value and type"
    },
    "industry_id": {
      "type": "integer",
      "format": "int32",
      "description": "Industry ID matching the experience"
    },
    "job_function_id": {
      "type": "integer",
      "format": "int32",
      "description": "Job Function ID matching the experience"
    },
    "external_id": {
      "type": "string",
      "description": "Experience ID in your database"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience creation date"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience last update date time - iso8601"
    }
  },
  "description": "ExperienceCompact model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Update existing user experience
PUT/api/admin/v1/users/{user_id}/experiences/{id}

Update a user experience

Find the user experience matching its ID and associated user ID, or use external_id or previous_id as the key parameter to identify the user on one of these identifier instead of default user ID.

URI Parameters
id
string (required) 

Experience ID

user_id
number (required) 

GET /api/admin/v1/users/user_id/experiences/id?key=&experience_key=
Responses200

Get user experience

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "position": {
      "type": "string",
      "description": "Experience position"
    },
    "from": {
      "type": "string",
      "format": "date",
      "description": "Experience started at"
    },
    "to": {
      "type": "string",
      "format": "date",
      "description": "Experience ended at"
    },
    "companies_company_id": {
      "type": "string",
      "description": "ID of company linked"
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Array of customizable attributes with name, value and type"
    },
    "industry_id": {
      "type": "integer",
      "format": "int32",
      "description": "Industry ID matching the experience"
    },
    "job_function_id": {
      "type": "integer",
      "format": "int32",
      "description": "Job Function ID matching the experience"
    },
    "external_id": {
      "type": "string",
      "description": "Experience ID in your database"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience creation date"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience last update date time - iso8601"
    }
  },
  "description": "ExperienceCompact model"
}

Get user experience
GET/api/admin/v1/users/{user_id}/experiences/{id}{?key,experience_key}

Return the user experience based on its ID and associated user ID

Find the user experience matching its ID and associated user ID, or use external_id or previous_id as the key parameter to identify the user on one of these identifier instead of default user ID.

URI Parameters
key
string (required) 
experience_key
string (required) 
user_id
number (required) 
id
number (required) 

PUT /api/admin/v1/users/user_id/experiences/_bulk
Requests
Body
{
  "key": "Hello, world!",
  "experiences[id]": [],
  "experiences[experience_key]": [],
  "experiences[companies_company_key]": [],
  "experiences[position]": [],
  "experiences[from]": [],
  "experiences[to]": [],
  "experiences[companies_company_id]": [],
  "experiences[custom_attributes]": [],
  "experiences[industry_id]": [
    1
  ],
  "experiences[job_function_id]": [
    1
  ],
  "experiences[external_id]": []
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "experiences[id]": {
      "type": "array",
      "description": "Experience ID\n\n+"
    },
    "experiences[experience_key]": {
      "type": "array",
      "description": "+"
    },
    "experiences[companies_company_key]": {
      "type": "array",
      "description": "+"
    },
    "experiences[position]": {
      "type": "array",
      "description": "Experience position\n\n+"
    },
    "experiences[from]": {
      "type": "array",
      "description": "Experience started at\n\n+"
    },
    "experiences[to]": {
      "type": "array",
      "description": "Experience ended at\n\n+"
    },
    "experiences[companies_company_id]": {
      "type": "array",
      "description": "ID of company linked\n\n+"
    },
    "experiences[custom_attributes]": {
      "type": "array",
      "description": "Array of customizable attributes with name, value and type\n\n+"
    },
    "experiences[industry_id]": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Industry ID matching the experience"
    },
    "experiences[job_function_id]": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Job Function ID matching the experience"
    },
    "experiences[external_id]": {
      "type": "array",
      "description": "Experience ID in your database\n\n+"
    }
  },
  "required": [
    "experiences[id]"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200422

Bulk update of existing user experiences

Schema
{
  "type": "object",
  "properties": {
    "experiences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique ID"
          },
          "position": {
            "type": "string",
            "description": "Experience position"
          },
          "from": {
            "type": "string",
            "format": "date",
            "description": "Experience started at"
          },
          "to": {
            "type": "string",
            "format": "date",
            "description": "Experience ended at"
          },
          "companies_company_id": {
            "type": "string",
            "description": "ID of company linked"
          },
          "custom_attributes": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Array of customizable attributes with name, value and type"
          },
          "industry_id": {
            "type": "integer",
            "format": "int32",
            "description": "Industry ID matching the experience"
          },
          "job_function_id": {
            "type": "integer",
            "format": "int32",
            "description": "Job Function ID matching the experience"
          },
          "external_id": {
            "type": "string",
            "description": "Experience ID in your database"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Experience creation date"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Experience last update date time - iso8601"
          }
        },
        "description": "ExperienceCompact model"
      }
    }
  },
  "description": "Experiences model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Bulk update of existing user experiences
PUT/api/admin/v1/users/{user_id}/experiences/_bulk

Batch update of user experiences

Find user experiences using the ID setted in the experiences hash, linked to the user set with the user ID or set external_id or previous_id as the key parameter to fetch user on this identifier instead of default ID, and set the correct value for the ID params in users.

WARNING: Swagger generated exemple of the parameters is false! You should use an array of user experiences data

{
  "experiences": [
    // experience 1
    {
      "id": 1,
      "position": "string",
      "companies_company_id": 0
      ...
    },
    // experience 2
    {
      "id": 2,
      "position": "string",
      "companies_company_id": 0
      ...
    },
  ]
}

Errors

If any user experiences failed to update, the whole transaction is rollbacked

URI Parameters
user_id
number (required) 

POST /api/admin/v1/users/user_id/experiences/_bulk
Requests
Body
{
  "key": "Hello, world!",
  "experiences[position]": [],
  "experiences[companies_company_id]": [],
  "experiences[companies_company_key]": [],
  "experiences[from]": [],
  "experiences[to]": [],
  "experiences[custom_attributes]": [],
  "experiences[industry_id]": [
    1
  ],
  "experiences[job_function_id]": [
    1
  ],
  "experiences[external_id]": []
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "experiences[position]": {
      "type": "array",
      "description": "User position\n\n+"
    },
    "experiences[companies_company_id]": {
      "type": "array",
      "description": "Company linked to experience\n\n+"
    },
    "experiences[companies_company_key]": {
      "type": "array",
      "description": "+"
    },
    "experiences[from]": {
      "type": "array",
      "description": "Experience started at\n\n+"
    },
    "experiences[to]": {
      "type": "array",
      "description": "Experience ended at\n\n+"
    },
    "experiences[custom_attributes]": {
      "type": "array",
      "description": "Array of customizable attributes with name, value and type\n\n+"
    },
    "experiences[industry_id]": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Industry ID matching the experience"
    },
    "experiences[job_function_id]": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Job Function ID matching the experience"
    },
    "experiences[external_id]": {
      "type": "array",
      "description": "Experience ID in your database\n\n+"
    }
  },
  "required": [
    "experiences[position]",
    "experiences[companies_company_id]"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses201422

Bulk add experiences

Schema
{
  "type": "object",
  "properties": {
    "experiences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique ID"
          },
          "position": {
            "type": "string",
            "description": "Experience position"
          },
          "from": {
            "type": "string",
            "format": "date",
            "description": "Experience started at"
          },
          "to": {
            "type": "string",
            "format": "date",
            "description": "Experience ended at"
          },
          "companies_company_id": {
            "type": "string",
            "description": "ID of company linked"
          },
          "custom_attributes": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Array of customizable attributes with name, value and type"
          },
          "industry_id": {
            "type": "integer",
            "format": "int32",
            "description": "Industry ID matching the experience"
          },
          "job_function_id": {
            "type": "integer",
            "format": "int32",
            "description": "Job Function ID matching the experience"
          },
          "external_id": {
            "type": "string",
            "description": "Experience ID in your database"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Experience creation date"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Experience last update date time - iso8601"
          }
        },
        "description": "ExperienceCompact model"
      }
    }
  },
  "description": "Experiences model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Bulk add experiences
POST/api/admin/v1/users/{user_id}/experiences/_bulk

Batch creation of user experiences

WARNING: Swagger generated exemple of the parameters is false! You should use an array of user experiences data

{
  "experiences": [
    // experience 1
    {
      "position": "string",
      "companies_company_id": 0
      ...
    },
    // experience 2
    {
      "position": "string",
      "companies_company_id": 0
      ...
    },
  ]
}

Errors

If any user experience failed to save, the whole transaction is rollbacked

URI Parameters
user_id
number (required) 

POST /api/admin/v1/users/user_id/experiences
Requests
Body
{
  "key": "Hello, world!",
  "experience[position]": "Hello, world!",
  "experience[companies_company_id]": "Hello, world!",
  "experience[companies_company_key]": "Hello, world!",
  "experience[from]": "Hello, world!",
  "experience[to]": "Hello, world!",
  "experience[custom_attributes]": [],
  "experience[industry_id]": 1,
  "experience[job_function_id]": 1,
  "experience[external_id]": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "experience[position]": {
      "type": "string",
      "description": "User position"
    },
    "experience[companies_company_id]": {
      "type": "string",
      "description": "Company linked to experience"
    },
    "experience[companies_company_key]": {
      "type": "string"
    },
    "experience[from]": {
      "type": "string",
      "description": "Experience started at"
    },
    "experience[to]": {
      "type": "string",
      "description": "Experience ended at"
    },
    "experience[custom_attributes]": {
      "type": "array",
      "description": "Array of customizable attributes with name, value and type\n\n+"
    },
    "experience[industry_id]": {
      "type": "number",
      "description": "Industry ID matching the experience"
    },
    "experience[job_function_id]": {
      "type": "number",
      "description": "Job Function ID matching the experience"
    },
    "experience[external_id]": {
      "type": "string",
      "description": "Experience ID in your database"
    }
  },
  "required": [
    "experience[position]",
    "experience[companies_company_id]"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses201422

Add a new experience

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "position": {
      "type": "string",
      "description": "Experience position"
    },
    "from": {
      "type": "string",
      "format": "date",
      "description": "Experience started at"
    },
    "to": {
      "type": "string",
      "format": "date",
      "description": "Experience ended at"
    },
    "companies_company_id": {
      "type": "string",
      "description": "ID of company linked"
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Array of customizable attributes with name, value and type"
    },
    "industry_id": {
      "type": "integer",
      "format": "int32",
      "description": "Industry ID matching the experience"
    },
    "job_function_id": {
      "type": "integer",
      "format": "int32",
      "description": "Job Function ID matching the experience"
    },
    "external_id": {
      "type": "string",
      "description": "Experience ID in your database"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience creation date"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience last update date time - iso8601"
    }
  },
  "description": "ExperienceCompact model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Add a new experience
POST/api/admin/v1/users/{user_id}/experiences

Return the created experience.

URI Parameters
user_id
number (required) 

GET /api/admin/v1/users/user_id/experiences?key=&page=&per_page=
Responses200

Get all user experiences

Schema
{
  "type": "object",
  "properties": {
    "experiences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique ID"
          },
          "position": {
            "type": "string",
            "description": "Experience position"
          },
          "from": {
            "type": "string",
            "format": "date",
            "description": "Experience started at"
          },
          "to": {
            "type": "string",
            "format": "date",
            "description": "Experience ended at"
          },
          "companies_company_id": {
            "type": "string",
            "description": "ID of company linked"
          },
          "custom_attributes": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Array of customizable attributes with name, value and type"
          },
          "industry_id": {
            "type": "integer",
            "format": "int32",
            "description": "Industry ID matching the experience"
          },
          "job_function_id": {
            "type": "integer",
            "format": "int32",
            "description": "Job Function ID matching the experience"
          },
          "external_id": {
            "type": "string",
            "description": "Experience ID in your database"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Experience creation date"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Experience last update date time - iso8601"
          }
        },
        "description": "ExperienceCompact model"
      }
    }
  },
  "description": "Experiences model"
}

Get all user experiences
GET/api/admin/v1/users/{user_id}/experiences{?key,page,per_page}

Return an array of experiences with basic information matching the associated user ID

Use external_id or previous_id as the key parameter to identify the user on one of these identifier instead of default user ID.

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/users/:user_id/experiences?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/users/:user_id/experiences?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/users/:user_id/experiences?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/users/:user_id/experiences?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
URI Parameters
key
string (required) 
page
string (required) 

Page of results to fetch.

per_page
string (required) 

Number of results to return per page.

user_id
number (required) 

DELETE /api/admin/v1/users/user_id/educations/id?key=&education_key=
Responses204

Delete User education

Delete User education
DELETE/api/admin/v1/users/{user_id}/educations/{id}{?key,education_key}

Delete the user education based on its ID and the associated user ID

Use `external_id` or `previous_id` as the **key** parameter to identify the user on one of these identifier instead of default user ID.
URI Parameters
key
string (required) 
id
string (required) 
education_key
string (required) 
user_id
number (required) 

PUT /api/admin/v1/users/user_id/educations/id
Requests
Body
{
  "key": "Hello, world!",
  "education_key": "Hello, world!",
  "education[degree]": "Hello, world!",
  "education[from]": "Hello, world!",
  "education[to]": "Hello, world!",
  "education[custom_attributes]": [],
  "education[field_of_study_id]": 1,
  "education[field_of_study_name]": "Hello, world!",
  "education[external_id]": "Hello, world!",
  "education[user_can_edit]": true
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "education_key": {
      "type": "string"
    },
    "education[degree]": {
      "type": "string",
      "description": "Education degree"
    },
    "education[from]": {
      "type": "string",
      "description": "Education started at"
    },
    "education[to]": {
      "type": "string",
      "description": "Education ended at"
    },
    "education[custom_attributes]": {
      "type": "array",
      "description": "Array of customizable attributes with name, value and type\n\n+"
    },
    "education[field_of_study_id]": {
      "type": "number",
      "description": "Field of study ID matching the education"
    },
    "education[field_of_study_name]": {
      "type": "string",
      "description": "Field of study name (from Field of study Object linked)"
    },
    "education[external_id]": {
      "type": "string",
      "description": "Education ID in your database"
    },
    "education[user_can_edit]": {
      "type": "boolean",
      "description": "Is this education editable by the user"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200422

Update existing user education

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "school_name": {
      "type": "string",
      "description": "Education school"
    },
    "degree": {
      "type": "string",
      "description": "Education degree"
    },
    "from": {
      "type": "string",
      "format": "date",
      "description": "Education started at"
    },
    "to": {
      "type": "string",
      "format": "date",
      "description": "Education ended at"
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Array of customizable attributes with name, value and type"
    },
    "field_of_study_id": {
      "type": "integer",
      "format": "int32",
      "description": "Field of study ID matching the education"
    },
    "field_of_study_name": {
      "type": "string",
      "description": "Field of study name (from Field of study Object linked)"
    },
    "external_id": {
      "type": "string",
      "description": "Education ID in your database"
    },
    "user_can_edit": {
      "type": "boolean",
      "description": "Is this education editable by the user"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Education creation date"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Education last update date time - iso8601"
    }
  },
  "description": "EducationCompact model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Update existing user education
PUT/api/admin/v1/users/{user_id}/educations/{id}

Update a user education

Find the user education matching its ID and associated user ID, or use external_id or previous_id as the key parameter to identify the user on one of these identifier instead of default user ID.

URI Parameters
id
string (required) 

Education ID

user_id
number (required) 

GET /api/admin/v1/users/user_id/educations/id?key=&education_key=
Responses200

Get user education

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "school_name": {
      "type": "string",
      "description": "Education school"
    },
    "degree": {
      "type": "string",
      "description": "Education degree"
    },
    "from": {
      "type": "string",
      "format": "date",
      "description": "Education started at"
    },
    "to": {
      "type": "string",
      "format": "date",
      "description": "Education ended at"
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Array of customizable attributes with name, value and type"
    },
    "field_of_study_id": {
      "type": "integer",
      "format": "int32",
      "description": "Field of study ID matching the education"
    },
    "field_of_study_name": {
      "type": "string",
      "description": "Field of study name (from Field of study Object linked)"
    },
    "external_id": {
      "type": "string",
      "description": "Education ID in your database"
    },
    "user_can_edit": {
      "type": "boolean",
      "description": "Is this education editable by the user"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Education creation date"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Education last update date time - iso8601"
    }
  },
  "description": "EducationCompact model"
}

Get user education
GET/api/admin/v1/users/{user_id}/educations/{id}{?key,education_key}

Return the user education based on its ID and associated user ID

Find the user education matching its ID and associated user ID, or use external_id or previous_id as the key parameter to identify the user on one of these identifier instead of default user ID.

URI Parameters
key
string (required) 
education_key
string (required) 
user_id
number (required) 
id
number (required) 

PUT /api/admin/v1/users/user_id/educations/_bulk
Requests
Body
{
  "key": "Hello, world!",
  "educations[education_key]": [],
  "educations[id]": [],
  "educations[degree]": [],
  "educations[from]": [],
  "educations[to]": [],
  "educations[custom_attributes]": [],
  "educations[field_of_study_id]": [
    1
  ],
  "educations[field_of_study_name]": [],
  "educations[external_id]": [],
  "educations[user_can_edit]": [
    true
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "educations[education_key]": {
      "type": "array",
      "description": "+"
    },
    "educations[id]": {
      "type": "array",
      "description": "Education ID\n\n+"
    },
    "educations[degree]": {
      "type": "array",
      "description": "Education degree\n\n+"
    },
    "educations[from]": {
      "type": "array",
      "description": "Education started at\n\n+"
    },
    "educations[to]": {
      "type": "array",
      "description": "Education ended at\n\n+"
    },
    "educations[custom_attributes]": {
      "type": "array",
      "description": "Array of customizable attributes with name, value and type\n\n+"
    },
    "educations[field_of_study_id]": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Field of study ID matching the education"
    },
    "educations[field_of_study_name]": {
      "type": "array",
      "description": "Field of study name (from Field of study Object linked)\n\n+"
    },
    "educations[external_id]": {
      "type": "array",
      "description": "Education ID in your database\n\n+"
    },
    "educations[user_can_edit]": {
      "type": "array",
      "items": {
        "type": "boolean"
      },
      "description": "Is this education editable by the user"
    }
  },
  "required": [
    "educations[id]"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200422

Bulk update of existing user educations

Schema
{
  "type": "object",
  "properties": {
    "educations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique ID"
          },
          "school_name": {
            "type": "string",
            "description": "Education school"
          },
          "degree": {
            "type": "string",
            "description": "Education degree"
          },
          "from": {
            "type": "string",
            "format": "date",
            "description": "Education started at"
          },
          "to": {
            "type": "string",
            "format": "date",
            "description": "Education ended at"
          },
          "custom_attributes": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Array of customizable attributes with name, value and type"
          },
          "field_of_study_id": {
            "type": "integer",
            "format": "int32",
            "description": "Field of study ID matching the education"
          },
          "field_of_study_name": {
            "type": "string",
            "description": "Field of study name (from Field of study Object linked)"
          },
          "external_id": {
            "type": "string",
            "description": "Education ID in your database"
          },
          "user_can_edit": {
            "type": "boolean",
            "description": "Is this education editable by the user"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Education creation date"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Education last update date time - iso8601"
          }
        },
        "description": "EducationCompact model"
      }
    }
  },
  "description": "Educations model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Bulk update of existing user educations
PUT/api/admin/v1/users/{user_id}/educations/_bulk

Batch update of user educations

Find user educations using the ID setted in the educations hash, linked to the user set with the user ID or set external_id or previous_id as the key parameter to fetch user on this identifier instead of default ID, and set the correct value for the ID params in users.

WARNING: Swagger generated exemple of the parameters is false! You should use an array of user educations data

{
  "educations": [
    // education 1
    {
      "id": 1,
      "school_name": "string",
      ...
    },
    // education 2
    {
      "id": 2,
      "school_name": "string",
      ...
    },
  ]
}

Errors

If any user educations failed to update, the whole transaction is rollbacked

URI Parameters
user_id
number (required) 

POST /api/admin/v1/users/user_id/educations/_bulk
Requests
Body
{
  "key": "Hello, world!",
  "educations[school_name]": [],
  "educations[degree]": [],
  "educations[from]": [],
  "educations[to]": [],
  "educations[custom_attributes]": [],
  "educations[field_of_study_id]": [
    1
  ],
  "educations[field_of_study_name]": [],
  "educations[external_id]": [],
  "educations[user_can_edit]": [
    true
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "educations[school_name]": {
      "type": "array",
      "description": "School name\n\n+"
    },
    "educations[degree]": {
      "type": "array",
      "description": "Education degree\n\n+"
    },
    "educations[from]": {
      "type": "array",
      "description": "Education started at\n\n+"
    },
    "educations[to]": {
      "type": "array",
      "description": "Education ended at\n\n+"
    },
    "educations[custom_attributes]": {
      "type": "array",
      "description": "Array of customizable attributes with name, value and type\n\n+"
    },
    "educations[field_of_study_id]": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Field of study ID matching the education"
    },
    "educations[field_of_study_name]": {
      "type": "array",
      "description": "Field of study name (from Field of study Object linked)\n\n+"
    },
    "educations[external_id]": {
      "type": "array",
      "description": "Education ID in your database\n\n+"
    },
    "educations[user_can_edit]": {
      "type": "array",
      "items": {
        "type": "boolean"
      },
      "description": "Is this education editable by the user"
    }
  },
  "required": [
    "educations[school_name]"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses201422

Bulk add educations

Schema
{
  "type": "object",
  "properties": {
    "educations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique ID"
          },
          "school_name": {
            "type": "string",
            "description": "Education school"
          },
          "degree": {
            "type": "string",
            "description": "Education degree"
          },
          "from": {
            "type": "string",
            "format": "date",
            "description": "Education started at"
          },
          "to": {
            "type": "string",
            "format": "date",
            "description": "Education ended at"
          },
          "custom_attributes": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Array of customizable attributes with name, value and type"
          },
          "field_of_study_id": {
            "type": "integer",
            "format": "int32",
            "description": "Field of study ID matching the education"
          },
          "field_of_study_name": {
            "type": "string",
            "description": "Field of study name (from Field of study Object linked)"
          },
          "external_id": {
            "type": "string",
            "description": "Education ID in your database"
          },
          "user_can_edit": {
            "type": "boolean",
            "description": "Is this education editable by the user"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Education creation date"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Education last update date time - iso8601"
          }
        },
        "description": "EducationCompact model"
      }
    }
  },
  "description": "Educations model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Bulk add educations
POST/api/admin/v1/users/{user_id}/educations/_bulk

Batch creation of user educations

WARNING: Swagger generated exemple of the parameters is false! You should use an array of user educations data

{
  "educations": [
    // education 1
    {
      "school_name": "string",
      ...
    },
    // education 2
    {
      "school_name": "string",
      ...
    },
  ]
}

Errors

If any user education failed to save, the whole transaction is rollbacked

URI Parameters
user_id
number (required) 

POST /api/admin/v1/users/user_id/educations
Requests
Body
{
  "key": "Hello, world!",
  "education[school_name]": "Hello, world!",
  "education[degree]": "Hello, world!",
  "education[from]": "Hello, world!",
  "education[to]": "Hello, world!",
  "education[custom_attributes]": [],
  "education[field_of_study_id]": 1,
  "education[field_of_study_name]": "Hello, world!",
  "education[external_id]": "Hello, world!",
  "education[user_can_edit]": true
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "education[school_name]": {
      "type": "string",
      "description": "School name"
    },
    "education[degree]": {
      "type": "string",
      "description": "Education degree"
    },
    "education[from]": {
      "type": "string",
      "description": "Education started at"
    },
    "education[to]": {
      "type": "string",
      "description": "Education ended at"
    },
    "education[custom_attributes]": {
      "type": "array",
      "description": "Array of customizable attributes with name, value and type\n\n+"
    },
    "education[field_of_study_id]": {
      "type": "number",
      "description": "Field of study ID matching the education"
    },
    "education[field_of_study_name]": {
      "type": "string",
      "description": "Field of study name (from Field of study Object linked)"
    },
    "education[external_id]": {
      "type": "string",
      "description": "Education ID in your database"
    },
    "education[user_can_edit]": {
      "type": "boolean",
      "description": "Is this education editable by the user"
    }
  },
  "required": [
    "education[school_name]"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses201422

Add a new education

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "school_name": {
      "type": "string",
      "description": "Education school"
    },
    "degree": {
      "type": "string",
      "description": "Education degree"
    },
    "from": {
      "type": "string",
      "format": "date",
      "description": "Education started at"
    },
    "to": {
      "type": "string",
      "format": "date",
      "description": "Education ended at"
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Array of customizable attributes with name, value and type"
    },
    "field_of_study_id": {
      "type": "integer",
      "format": "int32",
      "description": "Field of study ID matching the education"
    },
    "field_of_study_name": {
      "type": "string",
      "description": "Field of study name (from Field of study Object linked)"
    },
    "external_id": {
      "type": "string",
      "description": "Education ID in your database"
    },
    "user_can_edit": {
      "type": "boolean",
      "description": "Is this education editable by the user"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Education creation date"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Education last update date time - iso8601"
    }
  },
  "description": "EducationCompact model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Add a new education
POST/api/admin/v1/users/{user_id}/educations

Return the created education.

URI Parameters
user_id
number (required) 

GET /api/admin/v1/users/user_id/educations?key=&page=&per_page=
Responses200

Get all user educations

Schema
{
  "type": "object",
  "properties": {
    "educations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique ID"
          },
          "school_name": {
            "type": "string",
            "description": "Education school"
          },
          "degree": {
            "type": "string",
            "description": "Education degree"
          },
          "from": {
            "type": "string",
            "format": "date",
            "description": "Education started at"
          },
          "to": {
            "type": "string",
            "format": "date",
            "description": "Education ended at"
          },
          "custom_attributes": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Array of customizable attributes with name, value and type"
          },
          "field_of_study_id": {
            "type": "integer",
            "format": "int32",
            "description": "Field of study ID matching the education"
          },
          "field_of_study_name": {
            "type": "string",
            "description": "Field of study name (from Field of study Object linked)"
          },
          "external_id": {
            "type": "string",
            "description": "Education ID in your database"
          },
          "user_can_edit": {
            "type": "boolean",
            "description": "Is this education editable by the user"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Education creation date"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Education last update date time - iso8601"
          }
        },
        "description": "EducationCompact model"
      }
    }
  },
  "description": "Educations model"
}

Get all user educations
GET/api/admin/v1/users/{user_id}/educations{?key,page,per_page}

Return an array of educations with basic information matching the associated user ID

Use external_id or previous_id as the key parameter to identify the user on one of these identifier instead of default user ID.

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/users/:id/educations?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/users/:id/educations?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/users/:id/educations?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/users/:id/educations?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
URI Parameters
key
string (required) 
page
string (required) 

Page of results to fetch.

per_page
string (required) 

Number of results to return per page.

user_id
number (required) 

DELETE /api/admin/v1/users/user_id/memberships/id?user_key=
Responses204

Delete User membership

Delete User membership
DELETE/api/admin/v1/users/{user_id}/memberships/{id}{?user_key}

Delete the user membership based on its ID and the associated user ID

Use external_id or previous_id as the user_key parameter to identify the user on one of these identifier instead of default user ID.

URI Parameters
user_key
string (required) 
id
string (required) 

Membership ID

user_id
number (required) 

PUT /api/admin/v1/users/user_id/memberships/id
Requests
Body
{
  "user_key": "Hello, world!",
  "membership[status]": "Hello, world!",
  "membership[type_id]": "Hello, world!",
  "membership[type_external_id]": "Hello, world!",
  "membership[payment_method]": "Hello, world!",
  "membership[payment_at]": "Hello, world!",
  "membership[expires_at]": "Hello, world!",
  "membership[amount]": 1,
  "membership[notes]": "Hello, world!",
  "membership[recurring_payment_enabled]": true,
  "membership[created_at]": "Hello, world!",
  "membership[updated_at]": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "user_key": {
      "type": "string"
    },
    "membership[status]": {
      "type": "string",
      "description": "Membership status"
    },
    "membership[type_id]": {
      "type": "string",
      "description": "Membership type ID"
    },
    "membership[type_external_id]": {
      "type": "string",
      "description": "Membership type External ID (ID in your system)"
    },
    "membership[payment_method]": {
      "type": "string",
      "description": "Membership payment method"
    },
    "membership[payment_at]": {
      "type": "string",
      "description": "Membership payment date"
    },
    "membership[expires_at]": {
      "type": "string",
      "description": "Experience expiration date"
    },
    "membership[amount]": {
      "type": "number",
      "description": "Membership amount"
    },
    "membership[notes]": {
      "type": "string",
      "description": "Membership notes"
    },
    "membership[recurring_payment_enabled]": {
      "type": "boolean",
      "description": "Membership recurring payment ?"
    },
    "membership[created_at]": {
      "type": "string",
      "description": "Membership creation date"
    },
    "membership[updated_at]": {
      "type": "string",
      "description": "Membership last update date time - iso8601"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200422

Update user membership

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "status": {
      "type": "string",
      "enum": [
        "none",
        "paid"
      ],
      "description": "Membership status"
    },
    "type_name": {
      "type": "string",
      "description": "Membership type name"
    },
    "type_id": {
      "type": "string",
      "description": "Membership type ID"
    },
    "type_external_id": {
      "type": "string",
      "description": "Membership type External ID (ID in your system)"
    },
    "payment_method": {
      "type": "string",
      "enum": [
        "cash",
        "card",
        "check",
        "direct_debit",
        "bank_transfer",
        "external_institution"
      ],
      "description": "Membership payment method"
    },
    "payment_at": {
      "type": "string",
      "format": "date-time",
      "description": "Membership payment date"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience expiration date"
    },
    "amount": {
      "type": "number",
      "format": "float",
      "description": "Membership amount"
    },
    "currency": {
      "description": "Membership amount currency",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "name": {
          "type": "string",
          "description": "Currency name"
        },
        "code": {
          "type": "string",
          "description": "Currency code"
        },
        "symbol": {
          "type": "string",
          "description": "Currency symbol"
        }
      }
    },
    "notes": {
      "type": "string",
      "description": "Membership notes"
    },
    "recurring_payment_enabled": {
      "type": "boolean",
      "description": "Membership recurring payment ?"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Membership creation date"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Membership last update date time - iso8601"
    }
  },
  "description": "Membership model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Update user membership
PUT/api/admin/v1/users/{user_id}/memberships/{id}

Update a user membership

Find the user membership matching this ID.

URI Parameters
id
string (required) 

Membership ID

user_id
number (required) 

GET /api/admin/v1/users/user_id/memberships/id?user_key=
Responses200

Get user membership

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "status": {
      "type": "string",
      "enum": [
        "none",
        "paid"
      ],
      "description": "Membership status"
    },
    "type_name": {
      "type": "string",
      "description": "Membership type name"
    },
    "type_id": {
      "type": "string",
      "description": "Membership type ID"
    },
    "type_external_id": {
      "type": "string",
      "description": "Membership type External ID (ID in your system)"
    },
    "payment_method": {
      "type": "string",
      "enum": [
        "cash",
        "card",
        "check",
        "direct_debit",
        "bank_transfer",
        "external_institution"
      ],
      "description": "Membership payment method"
    },
    "payment_at": {
      "type": "string",
      "format": "date-time",
      "description": "Membership payment date"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience expiration date"
    },
    "amount": {
      "type": "number",
      "format": "float",
      "description": "Membership amount"
    },
    "currency": {
      "description": "Membership amount currency",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "name": {
          "type": "string",
          "description": "Currency name"
        },
        "code": {
          "type": "string",
          "description": "Currency code"
        },
        "symbol": {
          "type": "string",
          "description": "Currency symbol"
        }
      }
    },
    "notes": {
      "type": "string",
      "description": "Membership notes"
    },
    "recurring_payment_enabled": {
      "type": "boolean",
      "description": "Membership recurring payment ?"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Membership creation date"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Membership last update date time - iso8601"
    }
  },
  "description": "Membership model"
}

Get user membership
GET/api/admin/v1/users/{user_id}/memberships/{id}{?user_key}

Return a specific user’s membership

Find the user membership matching this ID

URI Parameters
user_key
string (required) 
id
string (required) 

Membership ID

user_id
number (required) 

POST /api/admin/v1/users/user_id/memberships
Requests
Body
{
  "user_key": "Hello, world!",
  "membership[status]": "Hello, world!",
  "membership[type_id]": "Hello, world!",
  "membership[type_external_id]": "Hello, world!",
  "membership[payment_method]": "Hello, world!",
  "membership[payment_at]": "Hello, world!",
  "membership[expires_at]": "Hello, world!",
  "membership[amount]": 1,
  "membership[notes]": "Hello, world!",
  "membership[recurring_payment_enabled]": true
}
Schema
{
  "type": "object",
  "properties": {
    "user_key": {
      "type": "string"
    },
    "membership[status]": {
      "type": "string",
      "description": "Membership status"
    },
    "membership[type_id]": {
      "type": "string",
      "description": "Membership type ID"
    },
    "membership[type_external_id]": {
      "type": "string",
      "description": "Membership type External ID (ID in your system)"
    },
    "membership[payment_method]": {
      "type": "string",
      "description": "Membership payment method"
    },
    "membership[payment_at]": {
      "type": "string",
      "description": "Membership payment date"
    },
    "membership[expires_at]": {
      "type": "string",
      "description": "Experience expiration date"
    },
    "membership[amount]": {
      "type": "number",
      "description": "Membership amount"
    },
    "membership[notes]": {
      "type": "string",
      "description": "Membership notes"
    },
    "membership[recurring_payment_enabled]": {
      "type": "boolean",
      "description": "Membership recurring payment ?"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses201422

Create user membership

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "status": {
      "type": "string",
      "enum": [
        "none",
        "paid"
      ],
      "description": "Membership status"
    },
    "type_name": {
      "type": "string",
      "description": "Membership type name"
    },
    "type_id": {
      "type": "string",
      "description": "Membership type ID"
    },
    "type_external_id": {
      "type": "string",
      "description": "Membership type External ID (ID in your system)"
    },
    "payment_method": {
      "type": "string",
      "enum": [
        "cash",
        "card",
        "check",
        "direct_debit",
        "bank_transfer",
        "external_institution"
      ],
      "description": "Membership payment method"
    },
    "payment_at": {
      "type": "string",
      "format": "date-time",
      "description": "Membership payment date"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience expiration date"
    },
    "amount": {
      "type": "number",
      "format": "float",
      "description": "Membership amount"
    },
    "currency": {
      "description": "Membership amount currency",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "name": {
          "type": "string",
          "description": "Currency name"
        },
        "code": {
          "type": "string",
          "description": "Currency code"
        },
        "symbol": {
          "type": "string",
          "description": "Currency symbol"
        }
      }
    },
    "notes": {
      "type": "string",
      "description": "Membership notes"
    },
    "recurring_payment_enabled": {
      "type": "boolean",
      "description": "Membership recurring payment ?"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Membership creation date"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Membership last update date time - iso8601"
    }
  },
  "description": "Membership model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Create user membership
POST/api/admin/v1/users/{user_id}/memberships

Create a user membership

Add a new membership for this user. You should set either type_id or type_external_id to select the associated membership’s type.

URI Parameters
user_id
number (required) 

GET /api/admin/v1/users/user_id/memberships?user_key=&order=&page=&per_page=
Responses200

Get all memberships

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "status": {
      "type": "string",
      "enum": [
        "none",
        "paid"
      ],
      "description": "Membership status"
    },
    "type_name": {
      "type": "string",
      "description": "Membership type name"
    },
    "type_id": {
      "type": "string",
      "description": "Membership type ID"
    },
    "type_external_id": {
      "type": "string",
      "description": "Membership type External ID (ID in your system)"
    },
    "payment_method": {
      "type": "string",
      "enum": [
        "cash",
        "card",
        "check",
        "direct_debit",
        "bank_transfer",
        "external_institution"
      ],
      "description": "Membership payment method"
    },
    "payment_at": {
      "type": "string",
      "format": "date-time",
      "description": "Membership payment date"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience expiration date"
    },
    "amount": {
      "type": "number",
      "format": "float",
      "description": "Membership amount"
    },
    "currency": {
      "description": "Membership amount currency",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "name": {
          "type": "string",
          "description": "Currency name"
        },
        "code": {
          "type": "string",
          "description": "Currency code"
        },
        "symbol": {
          "type": "string",
          "description": "Currency symbol"
        }
      }
    },
    "notes": {
      "type": "string",
      "description": "Membership notes"
    },
    "recurring_payment_enabled": {
      "type": "boolean",
      "description": "Membership recurring payment ?"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Membership creation date"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Membership last update date time - iso8601"
    }
  },
  "description": "Membership model"
}

Get all memberships
GET/api/admin/v1/users/{user_id}/memberships{?user_key,order,page,per_page}

Return an array of memberships

Use the param order to choose on which criterias the results should be ordered (e.g. order=updated_at to order by updated_at descending, use the minus operator to order by ascending value e.g. order=-updated_at).

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/memberships?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/memberships?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/memberships?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/memberships?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
URI Parameters
user_key
string (required) 
order
string (required) 
page
string (required) 

Page of results to fetch.

per_page
string (required) 

Number of results to return per page.

user_id
number (required) 

PUT /api/admin/v1/users/user_id/notification_settings
Requests
Body
{
  "key": "Hello, world!",
  "notification_settings[emailing_categories_subscribed_ids]": [
    1
  ],
  "notification_settings[post_email]": true,
  "notification_settings[trip_email]": true,
  "notification_settings[event_email]": true,
  "notification_settings[digest_email]": true,
  "notification_settings[comment_email]": true,
  "notification_settings[ventures_comment_email]": true,
  "notification_settings[businessopportunities_request]": true,
  "notification_settings[current_location_email]": true,
  "notification_settings[emailing_communication_email]": true,
  "notification_settings[forum_post_email]": true,
  "notification_settings[contact_by_phone]": true,
  "notification_settings[contact_by_sms]": true,
  "notification_settings[contact_by_post]": true,
  "notification_settings[groups_notifications][topic_id]": [
    1
  ],
  "notification_settings[groups_notifications][group_activity_frequency]": [],
  "notification_settings[groups_notifications][emailing_campaign_enabled]": [
    true
  ],
  "notification_settings[groups_notifications][category_subscribed_ids]": []
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "notification_settings[emailing_categories_subscribed_ids]": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Emailing category ids subscribed"
    },
    "notification_settings[post_email]": {
      "type": "boolean",
      "description": "Receive notifications for new posts"
    },
    "notification_settings[trip_email]": {
      "type": "boolean",
      "description": "Receive notifications for new trips"
    },
    "notification_settings[event_email]": {
      "type": "boolean",
      "description": "Receive notifications for new user events"
    },
    "notification_settings[digest_email]": {
      "type": "boolean",
      "description": "Receive notifications for new digests"
    },
    "notification_settings[comment_email]": {
      "type": "boolean",
      "description": "Receive notifications for new comments"
    },
    "notification_settings[ventures_comment_email]": {
      "type": "boolean",
      "description": "Receive notifications for new ventures comments"
    },
    "notification_settings[businessopportunities_request]": {
      "type": "boolean",
      "description": "Receive notifications for new business opportunities"
    },
    "notification_settings[current_location_email]": {
      "type": "boolean",
      "description": "Receive notifications for new checkins"
    },
    "notification_settings[emailing_communication_email]": {
      "type": "boolean",
      "description": "Consent to receive campaigns via email"
    },
    "notification_settings[forum_post_email]": {
      "type": "boolean",
      "description": "Receive notifications for new forum posts"
    },
    "notification_settings[contact_by_phone]": {
      "type": "boolean",
      "description": "Consent to receive campaigns via phone"
    },
    "notification_settings[contact_by_sms]": {
      "type": "boolean",
      "description": "Consent to receive campaigns via SMS"
    },
    "notification_settings[contact_by_post]": {
      "type": "boolean",
      "description": "Consent to receive campaigns via post"
    },
    "notification_settings[groups_notifications][topic_id]": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "notification_settings[groups_notifications][group_activity_frequency]": {
      "type": "array",
      "description": "+"
    },
    "notification_settings[groups_notifications][emailing_campaign_enabled]": {
      "type": "array",
      "items": {
        "type": "boolean"
      }
    },
    "notification_settings[groups_notifications][category_subscribed_ids]": {
      "type": "array",
      "description": "Group category ids subscribed\n\n+"
    }
  },
  "required": [
    "notification_settings[groups_notifications][topic_id]"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200422

Update this user notification settings

Schema
{
  "type": "object",
  "properties": {
    "post_email": {
      "type": "boolean",
      "description": "Receive notifications for new posts"
    },
    "trip_email": {
      "type": "boolean",
      "description": "Receive notifications for new trips"
    },
    "event_email": {
      "type": "boolean",
      "description": "Receive notifications for new user events"
    },
    "digest_email": {
      "type": "boolean",
      "description": "Receive notifications for new digests"
    },
    "comment_email": {
      "type": "boolean",
      "description": "Receive notifications for new comments"
    },
    "ventures_comment_email": {
      "type": "boolean",
      "description": "Receive notifications for new ventures comments"
    },
    "businessopportunities_request": {
      "type": "boolean",
      "description": "Receive notifications for new business opportunities"
    },
    "current_location_email": {
      "type": "boolean",
      "description": "Receive notifications for new checkins"
    },
    "emailing_communication_email": {
      "type": "boolean",
      "description": "Consent to receive campaigns via email"
    },
    "forum_post_email": {
      "type": "boolean",
      "description": "Receive notifications for new forum posts"
    },
    "contact_by_phone": {
      "type": "boolean",
      "description": "Consent to receive campaigns via phone"
    },
    "contact_by_sms": {
      "type": "boolean",
      "description": "Consent to receive campaigns via SMS"
    },
    "contact_by_post": {
      "type": "boolean",
      "description": "Consent to receive campaigns via post"
    },
    "emailing_categories_subscribed": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique ID"
          },
          "name": {
            "type": "string",
            "description": "Name of the category"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Category creation date time - iso8601"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Category last update date time - iso8601"
          }
        },
        "description": "NetworkCategory model"
      },
      "description": "Emailing campaigns categories subscribed"
    },
    "groups_notifications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "topic_id": {
            "type": "integer",
            "format": "int32",
            "description": "Group ID"
          },
          "notification_enabled": {
            "type": "boolean",
            "description": "Receives notifications upon activity in the group"
          },
          "group_activity_frequency": {
            "type": "string",
            "enum": [
              "none",
              "instant",
              "daily",
              "weekly"
            ],
            "description": "Frequency to which the user receives notifications upon activity in the group"
          },
          "emailing_campaign_enabled": {
            "type": "boolean",
            "description": "Receives emailing campaign from administrators of the group"
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Unique ID"
                },
                "name": {
                  "type": "string",
                  "description": "Name of the category"
                }
              },
              "description": "NetworkCategoryCompact model"
            },
            "description": "Network categories linked to the group"
          }
        }
      }
    }
  },
  "description": "NotificationSettings model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Update this user notification settings
PUT/api/admin/v1/users/{user_id}/notification_settings

Update this user notification settings

URI Parameters
user_id
number (required) 

GET /api/admin/v1/users/user_id/notification_settings?key=
Responses200

Return all notification settings for this user

Schema
{
  "type": "object",
  "properties": {
    "post_email": {
      "type": "boolean",
      "description": "Receive notifications for new posts"
    },
    "trip_email": {
      "type": "boolean",
      "description": "Receive notifications for new trips"
    },
    "event_email": {
      "type": "boolean",
      "description": "Receive notifications for new user events"
    },
    "digest_email": {
      "type": "boolean",
      "description": "Receive notifications for new digests"
    },
    "comment_email": {
      "type": "boolean",
      "description": "Receive notifications for new comments"
    },
    "ventures_comment_email": {
      "type": "boolean",
      "description": "Receive notifications for new ventures comments"
    },
    "businessopportunities_request": {
      "type": "boolean",
      "description": "Receive notifications for new business opportunities"
    },
    "current_location_email": {
      "type": "boolean",
      "description": "Receive notifications for new checkins"
    },
    "emailing_communication_email": {
      "type": "boolean",
      "description": "Consent to receive campaigns via email"
    },
    "forum_post_email": {
      "type": "boolean",
      "description": "Receive notifications for new forum posts"
    },
    "contact_by_phone": {
      "type": "boolean",
      "description": "Consent to receive campaigns via phone"
    },
    "contact_by_sms": {
      "type": "boolean",
      "description": "Consent to receive campaigns via SMS"
    },
    "contact_by_post": {
      "type": "boolean",
      "description": "Consent to receive campaigns via post"
    },
    "emailing_categories_subscribed": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique ID"
          },
          "name": {
            "type": "string",
            "description": "Name of the category"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Category creation date time - iso8601"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Category last update date time - iso8601"
          }
        },
        "description": "NetworkCategory model"
      },
      "description": "Emailing campaigns categories subscribed"
    },
    "groups_notifications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "topic_id": {
            "type": "integer",
            "format": "int32",
            "description": "Group ID"
          },
          "notification_enabled": {
            "type": "boolean",
            "description": "Receives notifications upon activity in the group"
          },
          "group_activity_frequency": {
            "type": "string",
            "enum": [
              "none",
              "instant",
              "daily",
              "weekly"
            ],
            "description": "Frequency to which the user receives notifications upon activity in the group"
          },
          "emailing_campaign_enabled": {
            "type": "boolean",
            "description": "Receives emailing campaign from administrators of the group"
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Unique ID"
                },
                "name": {
                  "type": "string",
                  "description": "Name of the category"
                }
              },
              "description": "NetworkCategoryCompact model"
            },
            "description": "Network categories linked to the group"
          }
        }
      }
    }
  },
  "description": "NotificationSettings model"
}

Return all notification settings for this user
GET/api/admin/v1/users/{user_id}/notification_settings{?key}

Return this user notification settings

URI Parameters
key
string (required) 
user_id
number (required) 

PUT /api/admin/v1/users/postal_addresses/id
Requests
Body
{
  "postal_address[address_1]": "Hello, world!",
  "postal_address[address_2]": "Hello, world!",
  "postal_address[address_3]": "Hello, world!",
  "postal_address[city]": "Hello, world!",
  "postal_address[state]": "Hello, world!",
  "postal_address[postal_code]": "Hello, world!",
  "postal_address[country]": "Hello, world!",
  "postal_address[default_billing_address]": true,
  "postal_address[created_at]": "Hello, world!",
  "postal_address[updated_at]": "Hello, world!",
  "postal_address[user_id]": 1
}
Schema
{
  "type": "object",
  "properties": {
    "postal_address[address_1]": {
      "type": "string",
      "description": "Address line 1"
    },
    "postal_address[address_2]": {
      "type": "string",
      "description": "Address line 2"
    },
    "postal_address[address_3]": {
      "type": "string",
      "description": "Address line 3"
    },
    "postal_address[city]": {
      "type": "string",
      "description": "City"
    },
    "postal_address[state]": {
      "type": "string",
      "description": "State"
    },
    "postal_address[postal_code]": {
      "type": "string",
      "description": "Zip code"
    },
    "postal_address[country]": {
      "type": "string",
      "description": "Country"
    },
    "postal_address[default_billing_address]": {
      "type": "boolean",
      "description": "is the default billing address for the user ?"
    },
    "postal_address[created_at]": {
      "type": "string",
      "description": "Postal address creation date time - iso8601"
    },
    "postal_address[updated_at]": {
      "type": "string",
      "description": "Postal address last update date time - iso8601"
    },
    "postal_address[user_id]": {
      "type": "number",
      "description": "User ID linked to postal address"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200422

Update existing postal address

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "address_1": {
      "type": "string",
      "description": "Address line 1"
    },
    "address_2": {
      "type": "string",
      "description": "Address line 2"
    },
    "address_3": {
      "type": "string",
      "description": "Address line 3"
    },
    "city": {
      "type": "string",
      "description": "City"
    },
    "state": {
      "type": "string",
      "description": "State"
    },
    "postal_code": {
      "type": "string",
      "description": "Zip code"
    },
    "country": {
      "type": "string",
      "enum": [
        "TJ",
        "JM",
        "HT",
        "ST",
        "MS",
        "AE",
        "PK",
        "NL",
        "LU",
        "BZ",
        "IR",
        "BO",
        "UY",
        "GH",
        "SA",
        "CI",
        "MF",
        "TF",
        "AI",
        "QA",
        "SX",
        "LY",
        "BV",
        "PG",
        "KG",
        "GQ",
        "EH",
        "NU",
        "PR",
        "GD",
        "KR",
        "HM",
        "SM",
        "SL",
        "CD",
        "MK",
        "TR",
        "DZ",
        "GE",
        "PS",
        "BB",
        "UA",
        "GP",
        "PF",
        "NA",
        "BW",
        "SY",
        "TG",
        "DO",
        "AQ",
        "CH",
        "MG",
        "FO",
        "VG",
        "GI",
        "BN",
        "LA",
        "IS",
        "EE",
        "UM",
        "LT",
        "RS",
        "MR",
        "AD",
        "HU",
        "TK",
        "MY",
        "AO",
        "CV",
        "NF",
        "PA",
        "GW",
        "BE",
        "PT",
        "GB",
        "IM",
        "US",
        "YE",
        "HK",
        "AZ",
        "CC",
        "ML",
        "SK",
        "VU",
        "TL",
        "HR",
        "SR",
        "MU",
        "CZ",
        "PM",
        "LS",
        "WS",
        "KM",
        "IT",
        "BI",
        "WF",
        "GN",
        "SG",
        "CO",
        "CN",
        "AW",
        "MA",
        "FI",
        "VA",
        "ZW",
        "KY",
        "BH",
        "PY",
        "EC",
        "LR",
        "RU",
        "PL",
        "OM",
        "MT",
        "SS",
        "DE",
        "TM",
        "SJ",
        "MM",
        "TT",
        "IL",
        "BD",
        "NR",
        "LK",
        "UG",
        "NG",
        "BQ",
        "MX",
        "CW",
        "SI",
        "MN",
        "CA",
        "AX",
        "VN",
        "TW",
        "JP",
        "IO",
        "RO",
        "BG",
        "GU",
        "BR",
        "AM",
        "ZM",
        "DJ",
        "JE",
        "AT",
        "CM",
        "SE",
        "FJ",
        "KZ",
        "GL",
        "GY",
        "CX",
        "MW",
        "TN",
        "ZA",
        "TO",
        "CY",
        "MV",
        "PN",
        "RW",
        "NI",
        "KN",
        "BJ",
        "ET",
        "GM",
        "TZ",
        "VC",
        "FK",
        "SD",
        "MC",
        "AU",
        "CL",
        "DK",
        "FR",
        "TC",
        "CU",
        "AL",
        "MZ",
        "BS",
        "NE",
        "GT",
        "LI",
        "NP",
        "BF",
        "PW",
        "KW",
        "IN",
        "GA",
        "TV",
        "MO",
        "SH",
        "MD",
        "CK",
        "AR",
        "SC",
        "IE",
        "ES",
        "LB",
        "BM",
        "RE",
        "KI",
        "AG",
        "MQ",
        "SV",
        "JO",
        "TH",
        "SO",
        "MH",
        "CG",
        "KP",
        "GF",
        "BA",
        "YT",
        "GS",
        "KE",
        "PE",
        "BT",
        "SZ",
        "CR",
        "TD",
        "DM",
        "NC",
        "GR",
        "GG",
        "HN",
        "VI",
        "CF",
        "SN",
        "AF",
        "MP",
        "PH",
        "BY",
        "LV",
        "NO",
        "EG",
        "KH",
        "IQ",
        "LC",
        "NZ",
        "BL",
        "UZ",
        "ID",
        "ER",
        "VE",
        "FM",
        "SB",
        "ME",
        "AS",
        "XK"
      ],
      "description": "Country"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Postal address creation date time - iso8601"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Postal address last update date time - iso8601"
    }
  },
  "description": "PostalAddress model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Update existing postal address
PUT/api/admin/v1/users/postal_addresses/{id}

Update a postal address

URI Parameters
id
string (required) 

Education ID


GET /api/admin/v1/users/postal_addresses/id
Responses200

Get postal address

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "address_1": {
      "type": "string",
      "description": "Address line 1"
    },
    "address_2": {
      "type": "string",
      "description": "Address line 2"
    },
    "address_3": {
      "type": "string",
      "description": "Address line 3"
    },
    "city": {
      "type": "string",
      "description": "City"
    },
    "state": {
      "type": "string",
      "description": "State"
    },
    "postal_code": {
      "type": "string",
      "description": "Zip code"
    },
    "country": {
      "type": "string",
      "enum": [
        "TJ",
        "JM",
        "HT",
        "ST",
        "MS",
        "AE",
        "PK",
        "NL",
        "LU",
        "BZ",
        "IR",
        "BO",
        "UY",
        "GH",
        "SA",
        "CI",
        "MF",
        "TF",
        "AI",
        "QA",
        "SX",
        "LY",
        "BV",
        "PG",
        "KG",
        "GQ",
        "EH",
        "NU",
        "PR",
        "GD",
        "KR",
        "HM",
        "SM",
        "SL",
        "CD",
        "MK",
        "TR",
        "DZ",
        "GE",
        "PS",
        "BB",
        "UA",
        "GP",
        "PF",
        "NA",
        "BW",
        "SY",
        "TG",
        "DO",
        "AQ",
        "CH",
        "MG",
        "FO",
        "VG",
        "GI",
        "BN",
        "LA",
        "IS",
        "EE",
        "UM",
        "LT",
        "RS",
        "MR",
        "AD",
        "HU",
        "TK",
        "MY",
        "AO",
        "CV",
        "NF",
        "PA",
        "GW",
        "BE",
        "PT",
        "GB",
        "IM",
        "US",
        "YE",
        "HK",
        "AZ",
        "CC",
        "ML",
        "SK",
        "VU",
        "TL",
        "HR",
        "SR",
        "MU",
        "CZ",
        "PM",
        "LS",
        "WS",
        "KM",
        "IT",
        "BI",
        "WF",
        "GN",
        "SG",
        "CO",
        "CN",
        "AW",
        "MA",
        "FI",
        "VA",
        "ZW",
        "KY",
        "BH",
        "PY",
        "EC",
        "LR",
        "RU",
        "PL",
        "OM",
        "MT",
        "SS",
        "DE",
        "TM",
        "SJ",
        "MM",
        "TT",
        "IL",
        "BD",
        "NR",
        "LK",
        "UG",
        "NG",
        "BQ",
        "MX",
        "CW",
        "SI",
        "MN",
        "CA",
        "AX",
        "VN",
        "TW",
        "JP",
        "IO",
        "RO",
        "BG",
        "GU",
        "BR",
        "AM",
        "ZM",
        "DJ",
        "JE",
        "AT",
        "CM",
        "SE",
        "FJ",
        "KZ",
        "GL",
        "GY",
        "CX",
        "MW",
        "TN",
        "ZA",
        "TO",
        "CY",
        "MV",
        "PN",
        "RW",
        "NI",
        "KN",
        "BJ",
        "ET",
        "GM",
        "TZ",
        "VC",
        "FK",
        "SD",
        "MC",
        "AU",
        "CL",
        "DK",
        "FR",
        "TC",
        "CU",
        "AL",
        "MZ",
        "BS",
        "NE",
        "GT",
        "LI",
        "NP",
        "BF",
        "PW",
        "KW",
        "IN",
        "GA",
        "TV",
        "MO",
        "SH",
        "MD",
        "CK",
        "AR",
        "SC",
        "IE",
        "ES",
        "LB",
        "BM",
        "RE",
        "KI",
        "AG",
        "MQ",
        "SV",
        "JO",
        "TH",
        "SO",
        "MH",
        "CG",
        "KP",
        "GF",
        "BA",
        "YT",
        "GS",
        "KE",
        "PE",
        "BT",
        "SZ",
        "CR",
        "TD",
        "DM",
        "NC",
        "GR",
        "GG",
        "HN",
        "VI",
        "CF",
        "SN",
        "AF",
        "MP",
        "PH",
        "BY",
        "LV",
        "NO",
        "EG",
        "KH",
        "IQ",
        "LC",
        "NZ",
        "BL",
        "UZ",
        "ID",
        "ER",
        "VE",
        "FM",
        "SB",
        "ME",
        "AS",
        "XK"
      ],
      "description": "Country"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Postal address creation date time - iso8601"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Postal address last update date time - iso8601"
    }
  },
  "description": "PostalAddress model"
}

Get postal address
GET/api/admin/v1/users/postal_addresses/{id}

Return the postal address based on its ID

URI Parameters
id
number (required) 

GET /api/admin/v1/users/postal_addresses
Responses200

Get all users postal addresses

Schema
{
  "type": "object",
  "properties": {
    "postal_addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique ID"
          },
          "address_1": {
            "type": "string",
            "description": "Address line 1"
          },
          "address_2": {
            "type": "string",
            "description": "Address line 2"
          },
          "address_3": {
            "type": "string",
            "description": "Address line 3"
          },
          "city": {
            "type": "string",
            "description": "City"
          },
          "state": {
            "type": "string",
            "description": "State"
          },
          "postal_code": {
            "type": "string",
            "description": "Zip code"
          },
          "country": {
            "type": "string",
            "enum": [
              "TJ",
              "JM",
              "HT",
              "ST",
              "MS",
              "AE",
              "PK",
              "NL",
              "LU",
              "BZ",
              "IR",
              "BO",
              "UY",
              "GH",
              "SA",
              "CI",
              "MF",
              "TF",
              "AI",
              "QA",
              "SX",
              "LY",
              "BV",
              "PG",
              "KG",
              "GQ",
              "EH",
              "NU",
              "PR",
              "GD",
              "KR",
              "HM",
              "SM",
              "SL",
              "CD",
              "MK",
              "TR",
              "DZ",
              "GE",
              "PS",
              "BB",
              "UA",
              "GP",
              "PF",
              "NA",
              "BW",
              "SY",
              "TG",
              "DO",
              "AQ",
              "CH",
              "MG",
              "FO",
              "VG",
              "GI",
              "BN",
              "LA",
              "IS",
              "EE",
              "UM",
              "LT",
              "RS",
              "MR",
              "AD",
              "HU",
              "TK",
              "MY",
              "AO",
              "CV",
              "NF",
              "PA",
              "GW",
              "BE",
              "PT",
              "GB",
              "IM",
              "US",
              "YE",
              "HK",
              "AZ",
              "CC",
              "ML",
              "SK",
              "VU",
              "TL",
              "HR",
              "SR",
              "MU",
              "CZ",
              "PM",
              "LS",
              "WS",
              "KM",
              "IT",
              "BI",
              "WF",
              "GN",
              "SG",
              "CO",
              "CN",
              "AW",
              "MA",
              "FI",
              "VA",
              "ZW",
              "KY",
              "BH",
              "PY",
              "EC",
              "LR",
              "RU",
              "PL",
              "OM",
              "MT",
              "SS",
              "DE",
              "TM",
              "SJ",
              "MM",
              "TT",
              "IL",
              "BD",
              "NR",
              "LK",
              "UG",
              "NG",
              "BQ",
              "MX",
              "CW",
              "SI",
              "MN",
              "CA",
              "AX",
              "VN",
              "TW",
              "JP",
              "IO",
              "RO",
              "BG",
              "GU",
              "BR",
              "AM",
              "ZM",
              "DJ",
              "JE",
              "AT",
              "CM",
              "SE",
              "FJ",
              "KZ",
              "GL",
              "GY",
              "CX",
              "MW",
              "TN",
              "ZA",
              "TO",
              "CY",
              "MV",
              "PN",
              "RW",
              "NI",
              "KN",
              "BJ",
              "ET",
              "GM",
              "TZ",
              "VC",
              "FK",
              "SD",
              "MC",
              "AU",
              "CL",
              "DK",
              "FR",
              "TC",
              "CU",
              "AL",
              "MZ",
              "BS",
              "NE",
              "GT",
              "LI",
              "NP",
              "BF",
              "PW",
              "KW",
              "IN",
              "GA",
              "TV",
              "MO",
              "SH",
              "MD",
              "CK",
              "AR",
              "SC",
              "IE",
              "ES",
              "LB",
              "BM",
              "RE",
              "KI",
              "AG",
              "MQ",
              "SV",
              "JO",
              "TH",
              "SO",
              "MH",
              "CG",
              "KP",
              "GF",
              "BA",
              "YT",
              "GS",
              "KE",
              "PE",
              "BT",
              "SZ",
              "CR",
              "TD",
              "DM",
              "NC",
              "GR",
              "GG",
              "HN",
              "VI",
              "CF",
              "SN",
              "AF",
              "MP",
              "PH",
              "BY",
              "LV",
              "NO",
              "EG",
              "KH",
              "IQ",
              "LC",
              "NZ",
              "BL",
              "UZ",
              "ID",
              "ER",
              "VE",
              "FM",
              "SB",
              "ME",
              "AS",
              "XK"
            ],
            "description": "Country"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Postal address creation date time - iso8601"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Postal address last update date time - iso8601"
          }
        },
        "description": "PostalAddress model"
      }
    }
  },
  "description": "PostalAddresses model"
}

Get all users postal addresses
GET/api/admin/v1/users/postal_addresses

Return an array of postal addresses

Use the param updated_since to fetch all postal addresses updated since this datetime (e.g. updated_since=2017-08-01T00:00:00)

Use the param order to choose on which criterias the results should be ordered (e.g. order=updated_at to order by updated_at descending, use the minus operator to order by ascending value e.g. order=-updated_at).

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/postal_addresses?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/postal_addresses?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1//postal_addresses?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/postal_addresses?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
URI Parameters
page
string (required) 

Page of results to fetch.

per_page
string (required) 

Number of results to return per page.

order
string (required) 
updated_since
string (required) 

GET /api/admin/v1/users/user_id/groups
Responses200

Return groups belonging of the user

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "email": {
      "type": "string",
      "description": "User email"
    },
    "name": {
      "type": "string",
      "description": "User full name"
    },
    "sub_network_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "IDs list of user sub networks"
    },
    "extended_updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
    },
    "joined_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp the User joined the topic - iso8601"
    }
  },
  "description": "Follower model"
}

Return groups belonging of the user
GET/api/admin/v1/users/{user_id}/groups

Return groups linked to the user

URI Parameters
key
string (required) 
status
string (required) 
user_id
number (required) 

POST /api/admin/v1/users/id/notify
Requests
Body
{
  "key": "Hello, world!",
  "recipient_type": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "recipient_type": {
      "type": "string"
    }
  },
  "required": [
    "recipient_type"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses201

Notify User

Notify User
POST/api/admin/v1/users/{id}/notify

Notify user

Send invitation mail to the user

Set the params recipient_type to send an invitation to the user. Availables values to select on which email it should be sent are :

  • email

  • email2

  • email1then2

  • email2then1

  • email1and2

URI Parameters
id
string (required) 

DELETE /api/admin/v1/users/id?key=
Responses204

Delete User

Delete User
DELETE/api/admin/v1/users/{id}{?key}

Delete the user based on it’s ID

URI Parameters
id
string (required) 
key
string (required) 

PUT /api/admin/v1/users/id
Requests
Body
{
  "key": "Hello, world!",
  "user[postal_personal][address_1]": "Hello, world!",
  "user[postal_personal][address_2]": "Hello, world!",
  "user[postal_personal][address_3]": "Hello, world!",
  "user[postal_personal][city]": "Hello, world!",
  "user[postal_personal][state]": "Hello, world!",
  "user[postal_personal][postal_code]": "Hello, world!",
  "user[postal_personal][country]": "Hello, world!",
  "user[postal_personal][default_billing_address]": true,
  "user[postal_personal][created_at]": "Hello, world!",
  "user[postal_personal][updated_at]": "Hello, world!",
  "user[postal_work][address_1]": "Hello, world!",
  "user[postal_work][address_2]": "Hello, world!",
  "user[postal_work][address_3]": "Hello, world!",
  "user[postal_work][city]": "Hello, world!",
  "user[postal_work][state]": "Hello, world!",
  "user[postal_work][postal_code]": "Hello, world!",
  "user[postal_work][country]": "Hello, world!",
  "user[postal_work][default_billing_address]": true,
  "user[postal_work][created_at]": "Hello, world!",
  "user[postal_work][updated_at]": "Hello, world!",
  "user[config][private_profile]": true,
  "user[config][opt_out_of_directory]": true,
  "user[config][share_gender]": "Hello, world!",
  "user[config][share_prefix_firstname]": "Hello, world!",
  "user[config][share_honorary_title]": "Hello, world!",
  "user[config][share_prefix_name]": "Hello, world!",
  "user[config][share_suffix_name]": "Hello, world!",
  "user[config][share_maidenname]": "Hello, world!",
  "user[config][share_birthday]": "Hello, world!",
  "user[config][share_birthplace]": "Hello, world!",
  "user[config][share_headline]": "Hello, world!",
  "user[config][share_nationalities]": "Hello, world!",
  "user[config][share_live_location]": "Hello, world!",
  "user[config][share_sub_networks]": "Hello, world!",
  "user[config][share_resume]": "Hello, world!",
  "user[config][share_summary]": "Hello, world!",
  "user[config][share_industries]": "Hello, world!",
  "user[config][share_skills]": "Hello, world!",
  "user[config][share_facebook_profile_url]:  - Privacy sharing status of facebook_profile_url": "Hello, world!",
  "user[config][share_instagram_profile_url]:  - Privacy sharing status of instagram_profile_url": "Hello, world!",
  "user[config][share_twitter]": "Hello, world!",
  "user[config][share_skype]": "Hello, world!",
  "user[config][share_linkedin_profile_url]:  - Privacy sharing status of linkedin_profile_url": "Hello, world!",
  "user[config][share_website]": "Hello, world!",
  "user[config][share_bbm]": "Hello, world!",
  "user[config][share_email]": "Hello, world!",
  "user[config][share_email2]": "Hello, world!",
  "user[config][share_email3]": "Hello, world!",
  "user[config][share_mobile_perso]": "Hello, world!",
  "user[config][share_landline_perso]": "Hello, world!",
  "user[config][share_mobile_pro]": "Hello, world!",
  "user[config][share_landline_pro]": "Hello, world!",
  "user[config][share_postal_personal]": "Hello, world!",
  "user[config][share_postal_work]": "Hello, world!",
  "user[config][share_memberships]": "Hello, world!",
  "user[config][share_educations]": "Hello, world!",
  "user[config][share_experiences]": "Hello, world!",
  "user[email]": "Hello, world!",
  "user[sub_network_ids]": [
    1
  ],
  "user[extended_updated_at]": "Hello, world!",
  "user[email2]": "Hello, world!",
  "user[email3]": "Hello, world!",
  "user[primary_email_choice]": "Hello, world!",
  "user[firstname]": "Hello, world!",
  "user[lastname]": "Hello, world!",
  "user[maidenname]": "Hello, world!",
  "user[prefix_firstname]": "Hello, world!",
  "user[prefix_name]": "Hello, world!",
  "user[suffix_name]": "Hello, world!",
  "user[external_id]": "Hello, world!",
  "user[sso_identifier]": "Hello, world!",
  "user[previous_id]": "Hello, world!",
  "user[is_active]": true,
  "user[gender]": "Hello, world!",
  "user[birthday]": "Hello, world!",
  "user[birthplace]": "Hello, world!",
  "user[headline]": "Hello, world!",
  "user[summary]": "Hello, world!",
  "user[created_at]": "Hello, world!",
  "user[updated_at]": "Hello, world!",
  "user[citizenship_ids]": [
    1
  ],
  "user[citizenship_country_codes]": [],
  "user[deceased]": true,
  "user[deceased_at]": "Hello, world!",
  "user[do_not_contact]": true,
  "user[mobile_perso]": "Hello, world!",
  "user[mobile_pro]": "Hello, world!",
  "user[landline_perso]": "Hello, world!",
  "user[landline_pro]": "Hello, world!",
  "user[preferred_phone_number]": "Hello, world!",
  "user[preferred_postal_address]": "Hello, world!",
  "user[role_id]": 1,
  "user[awards]": "Hello, world!",
  "user[linkedin_profile_url]": "Hello, world!",
  "user[website]": "Hello, world!",
  "user[skype]": "Hello, world!",
  "user[bbm]": "Hello, world!",
  "user[twitter]": "Hello, world!",
  "user[timezone]": "Hello, world!",
  "user[facebook_profile_url]": "Hello, world!",
  "user[instagram_profile_url]": "Hello, world!",
  "user[honorary_title]": "Hello, world!",
  "user[locale]": "Hello, world!",
  "user[share_email]": "Hello, world!",
  "user[share_email2]": "Hello, world!",
  "user[share_email3]": "Hello, world!",
  "user[share_postal_address_personal]": "Hello, world!",
  "user[share_postal_address_work]": "Hello, world!",
  "user[share_nationalities]": "Hello, world!",
  "user[share_resume]": "Hello, world!",
  "user[share_mobile_pro]": "Hello, world!",
  "user[share_mobile_perso]": "Hello, world!",
  "user[share_landline_pro]": "Hello, world!",
  "user[share_landline_perso]": "Hello, world!",
  "user[custom_attributes]": [],
  "user[photo]": "Hello, world!",
  "user[resume]": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "user[postal_personal][address_1]": {
      "type": "string",
      "description": "Address line 1"
    },
    "user[postal_personal][address_2]": {
      "type": "string",
      "description": "Address line 2"
    },
    "user[postal_personal][address_3]": {
      "type": "string",
      "description": "Address line 3"
    },
    "user[postal_personal][city]": {
      "type": "string",
      "description": "City"
    },
    "user[postal_personal][state]": {
      "type": "string",
      "description": "State"
    },
    "user[postal_personal][postal_code]": {
      "type": "string",
      "description": "Zip code"
    },
    "user[postal_personal][country]": {
      "type": "string",
      "description": "Country"
    },
    "user[postal_personal][default_billing_address]": {
      "type": "boolean",
      "description": "is the default billing address for the user ?"
    },
    "user[postal_personal][created_at]": {
      "type": "string",
      "description": "Postal address creation date time - iso8601"
    },
    "user[postal_personal][updated_at]": {
      "type": "string",
      "description": "Postal address last update date time - iso8601"
    },
    "user[postal_work][address_1]": {
      "type": "string",
      "description": "Address line 1"
    },
    "user[postal_work][address_2]": {
      "type": "string",
      "description": "Address line 2"
    },
    "user[postal_work][address_3]": {
      "type": "string",
      "description": "Address line 3"
    },
    "user[postal_work][city]": {
      "type": "string",
      "description": "City"
    },
    "user[postal_work][state]": {
      "type": "string",
      "description": "State"
    },
    "user[postal_work][postal_code]": {
      "type": "string",
      "description": "Zip code"
    },
    "user[postal_work][country]": {
      "type": "string",
      "description": "Country"
    },
    "user[postal_work][default_billing_address]": {
      "type": "boolean",
      "description": "is the default billing address for the user ?"
    },
    "user[postal_work][created_at]": {
      "type": "string",
      "description": "Postal address creation date time - iso8601"
    },
    "user[postal_work][updated_at]": {
      "type": "string",
      "description": "Postal address last update date time - iso8601"
    },
    "user[config][private_profile]": {
      "type": "boolean",
      "description": "Unique ID"
    },
    "user[config][opt_out_of_directory]": {
      "type": "boolean",
      "description": "Unique ID"
    },
    "user[config][share_gender]": {
      "type": "string",
      "description": "Privacy sharing status of gender"
    },
    "user[config][share_prefix_firstname]": {
      "type": "string",
      "description": "Privacy sharing status of prefix_firstname"
    },
    "user[config][share_honorary_title]": {
      "type": "string",
      "description": "Privacy sharing status of honorary_title"
    },
    "user[config][share_prefix_name]": {
      "type": "string",
      "description": "Privacy sharing status of prefix_name"
    },
    "user[config][share_suffix_name]": {
      "type": "string",
      "description": "Privacy sharing status of suffix_name"
    },
    "user[config][share_maidenname]": {
      "type": "string",
      "description": "Privacy sharing status of maidenname"
    },
    "user[config][share_birthday]": {
      "type": "string",
      "description": "Privacy sharing status of birthday"
    },
    "user[config][share_birthplace]": {
      "type": "string",
      "description": "Privacy sharing status of birthplace"
    },
    "user[config][share_headline]": {
      "type": "string",
      "description": "Privacy sharing status of headline"
    },
    "user[config][share_nationalities]": {
      "type": "string",
      "description": "Privacy sharing status of nationalities"
    },
    "user[config][share_live_location]": {
      "type": "string",
      "description": "Privacy sharing status of live_location"
    },
    "user[config][share_sub_networks]": {
      "type": "string",
      "description": "Privacy sharing status of sub_networks"
    },
    "user[config][share_resume]": {
      "type": "string",
      "description": "Privacy sharing status of resume"
    },
    "user[config][share_summary]": {
      "type": "string",
      "description": "Privacy sharing status of summary"
    },
    "user[config][share_industries]": {
      "type": "string",
      "description": "Privacy sharing status of industries"
    },
    "user[config][share_skills]": {
      "type": "string",
      "description": "Privacy sharing status of skills"
    },
    "user[config][share_facebook_profile_url]:  - Privacy sharing status of facebook_profile_url": {
      "type": "string"
    },
    "user[config][share_instagram_profile_url]:  - Privacy sharing status of instagram_profile_url": {
      "type": "string"
    },
    "user[config][share_twitter]": {
      "type": "string",
      "description": "Privacy sharing status of twitter"
    },
    "user[config][share_skype]": {
      "type": "string",
      "description": "Privacy sharing status of skype"
    },
    "user[config][share_linkedin_profile_url]:  - Privacy sharing status of linkedin_profile_url": {
      "type": "string"
    },
    "user[config][share_website]": {
      "type": "string",
      "description": "Privacy sharing status of website"
    },
    "user[config][share_bbm]": {
      "type": "string",
      "description": "Privacy sharing status of bbm"
    },
    "user[config][share_email]": {
      "type": "string",
      "description": "Privacy sharing status of email"
    },
    "user[config][share_email2]": {
      "type": "string",
      "description": "Privacy sharing status of email2"
    },
    "user[config][share_email3]": {
      "type": "string",
      "description": "Privacy sharing status of email3"
    },
    "user[config][share_mobile_perso]": {
      "type": "string",
      "description": "Privacy sharing status of mobile_perso"
    },
    "user[config][share_landline_perso]": {
      "type": "string",
      "description": "Privacy sharing status of landline_perso"
    },
    "user[config][share_mobile_pro]": {
      "type": "string",
      "description": "Privacy sharing status of mobile_pro"
    },
    "user[config][share_landline_pro]": {
      "type": "string",
      "description": "Privacy sharing status of landline_pro"
    },
    "user[config][share_postal_personal]": {
      "type": "string",
      "description": "Privacy sharing status of postal_personal"
    },
    "user[config][share_postal_work]": {
      "type": "string",
      "description": "Privacy sharing status of postal_work"
    },
    "user[config][share_memberships]": {
      "type": "string",
      "description": "Privacy sharing status of memberships"
    },
    "user[config][share_educations]": {
      "type": "string",
      "description": "Privacy sharing status of educations"
    },
    "user[config][share_experiences]": {
      "type": "string",
      "description": "Privacy sharing status of experiences"
    },
    "user[email]": {
      "type": "string",
      "description": "User email"
    },
    "user[sub_network_ids]": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "IDs list of user sub networks"
    },
    "user[extended_updated_at]": {
      "type": "string",
      "description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
    },
    "user[email2]": {
      "type": "string",
      "description": "User secondary email"
    },
    "user[email3]": {
      "type": "string",
      "description": "User complementary email"
    },
    "user[primary_email_choice]": {
      "type": "string",
      "description": "User primary email choice"
    },
    "user[firstname]": {
      "type": "string",
      "description": "User first name"
    },
    "user[lastname]": {
      "type": "string",
      "description": "User last name"
    },
    "user[maidenname]": {
      "type": "string",
      "description": "User maiden name"
    },
    "user[prefix_firstname]": {
      "type": "string",
      "description": "User prefix firstname"
    },
    "user[prefix_name]": {
      "type": "string",
      "description": "User prefix name"
    },
    "user[suffix_name]": {
      "type": "string",
      "description": "User suffix name"
    },
    "user[external_id]": {
      "type": "string",
      "description": "User ID in your database"
    },
    "user[sso_identifier]": {
      "type": "string",
      "description": "User identifier for SSO"
    },
    "user[previous_id]": {
      "type": "string",
      "description": "User ID in your community system"
    },
    "user[is_active]": {
      "type": "boolean",
      "description": "User account enabled ?"
    },
    "user[gender]": {
      "type": "string",
      "description": "User gender (male/female/other)"
    },
    "user[birthday]": {
      "type": "string",
      "description": "User birth date"
    },
    "user[birthplace]": {
      "type": "string",
      "description": "User birth place"
    },
    "user[headline]": {
      "type": "string",
      "description": "User headline"
    },
    "user[summary]": {
      "type": "string",
      "description": "User summary"
    },
    "user[created_at]": {
      "type": "string",
      "description": "User creation date time - iso8601. READ only, can't be updated"
    },
    "user[updated_at]": {
      "type": "string",
      "description": "User last update date time - iso8601. READ only, can't be updated"
    },
    "user[citizenship_ids]": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "List of citizenship IDs"
    },
    "user[citizenship_country_codes]": {
      "type": "array",
      "description": "List of ISO-3166-2 citizenship country codes\n\n+"
    },
    "user[deceased]": {
      "type": "boolean",
      "description": "User deceased ?"
    },
    "user[deceased_at]": {
      "type": "string",
      "description": "User decease date time - iso8601."
    },
    "user[do_not_contact]": {
      "type": "boolean",
      "description": "User can be contacted ?"
    },
    "user[mobile_perso]": {
      "type": "string",
      "description": "User mobile perso number"
    },
    "user[mobile_pro]": {
      "type": "string",
      "description": "User mobile pro number"
    },
    "user[landline_perso]": {
      "type": "string",
      "description": "User landline perso number"
    },
    "user[landline_pro]": {
      "type": "string",
      "description": "User landline pro number"
    },
    "user[preferred_phone_number]": {
      "type": "string",
      "description": "User preferred phone number"
    },
    "user[preferred_postal_address]": {
      "type": "string",
      "description": "User preferred postal address"
    },
    "user[role_id]": {
      "type": "number",
      "description": "User role ID"
    },
    "user[awards]": {
      "type": "string",
      "description": "User awards"
    },
    "user[linkedin_profile_url]": {
      "type": "string",
      "description": "User linkedin profile URL"
    },
    "user[website]": {
      "type": "string",
      "description": "User Website URL"
    },
    "user[skype]": {
      "type": "string",
      "description": "User skype profile"
    },
    "user[bbm]": {
      "type": "string",
      "description": "User BlackBerry Messenger profile"
    },
    "user[twitter]": {
      "type": "string",
      "description": "User twitter profile"
    },
    "user[timezone]": {
      "type": "string",
      "description": "User timezone"
    },
    "user[facebook_profile_url]": {
      "type": "string",
      "description": "User facebook profile URL"
    },
    "user[instagram_profile_url]": {
      "type": "string",
      "description": "User instagram profile URL"
    },
    "user[honorary_title]": {
      "type": "string",
      "description": "User's honorary title"
    },
    "user[locale]": {
      "type": "string",
      "description": "User Locale"
    },
    "user[share_email]": {
      "type": "string",
      "description": "User's visibility information regarding email"
    },
    "user[share_email2]": {
      "type": "string",
      "description": "User's visibility information regarding secondary email"
    },
    "user[share_email3]": {
      "type": "string",
      "description": "User's visibility information regarding complementary email"
    },
    "user[share_postal_address_personal]": {
      "type": "string",
      "description": "User's visibility information regarding postal home location"
    },
    "user[share_postal_address_work]": {
      "type": "string",
      "description": "User's visibility information regarding postal work location"
    },
    "user[share_nationalities]": {
      "type": "string",
      "description": "User's visibility information regarding nationalities"
    },
    "user[share_resume]": {
      "type": "string",
      "description": "User's visibility information regarding resume"
    },
    "user[share_mobile_pro]": {
      "type": "string",
      "description": "User's visibility information regarding work mobile phone"
    },
    "user[share_mobile_perso]": {
      "type": "string",
      "description": "User's visibility information regarding personal mobile phone"
    },
    "user[share_landline_pro]": {
      "type": "string",
      "description": "User's visibility information regarding professional landline phone"
    },
    "user[share_landline_perso]": {
      "type": "string",
      "description": "User's visibility information regarding personal landline phone"
    },
    "user[custom_attributes]": {
      "type": "array",
      "description": "Array of customizable attributes with name, value and type\n\n+"
    },
    "user[photo]": {
      "type": "string",
      "description": "Profile picture of the user"
    },
    "user[resume]": {
      "type": "string",
      "description": "Resume of the user"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200422

Update existing user

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "email": {
      "type": "string",
      "description": "User email"
    },
    "name": {
      "type": "string",
      "description": "User full name"
    },
    "sub_network_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "IDs list of user sub networks"
    },
    "extended_updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
    },
    "email2": {
      "type": "string",
      "description": "User secondary email"
    },
    "email3": {
      "type": "string",
      "description": "User complementary email"
    },
    "primary_email_choice": {
      "type": "string",
      "enum": [
        "email",
        "email2",
        "email3"
      ],
      "description": "User primary email choice"
    },
    "firstname": {
      "type": "string",
      "description": "User first name"
    },
    "lastname": {
      "type": "string",
      "description": "User last name"
    },
    "maidenname": {
      "type": "string",
      "description": "User maiden name"
    },
    "prefix_firstname": {
      "type": "string",
      "description": "User prefix firstname"
    },
    "prefix_name": {
      "type": "string",
      "description": "User prefix name"
    },
    "suffix_name": {
      "type": "string",
      "description": "User suffix name"
    },
    "external_id": {
      "type": "string",
      "description": "User ID in your database"
    },
    "sso_identifier": {
      "type": "string",
      "description": "User identifier for SSO"
    },
    "previous_id": {
      "type": "string",
      "description": "User ID in your community system"
    },
    "is_active": {
      "type": "boolean",
      "description": "User account enabled ?"
    },
    "gender": {
      "type": "string",
      "enum": [
        "male",
        "female",
        "other"
      ],
      "description": "User gender (male/female/other)"
    },
    "birthday": {
      "type": "string",
      "format": "date",
      "description": "User birth date"
    },
    "birthplace": {
      "type": "string",
      "description": "User birth place"
    },
    "headline": {
      "type": "string",
      "description": "User headline"
    },
    "summary": {
      "type": "string",
      "description": "User summary"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "User creation date time - iso8601. READ only, can't be updated"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "User last update date time - iso8601. READ only, can't be updated"
    },
    "confirmed_at": {
      "type": "string",
      "format": "date-time",
      "description": "User activation date time - iso8601. READ only, can't be updated"
    },
    "citizenship_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "List of citizenship IDs"
    },
    "citizenship_country_codes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of ISO-3166-2 citizenship country codes"
    },
    "deceased": {
      "type": "boolean",
      "description": "User deceased ?"
    },
    "deceased_at": {
      "type": "string",
      "format": "date-time",
      "description": "User decease date time - iso8601."
    },
    "photo": {
      "type": "object",
      "properties": {
        "large-url": {
          "type": "string",
          "description": "User large photo url"
        },
        "medium-url": {
          "type": "string",
          "description": "User medium photo url"
        },
        "thumb-url": {
          "type": "string",
          "description": "User thumb photo url"
        },
        "mini-url": {
          "type": "string",
          "description": "User mini photo url"
        },
        "friend-url": {
          "type": "string",
          "description": "User friend photo url"
        },
        "icon-url": {
          "type": "string",
          "description": "User icon photo url"
        }
      },
      "description": "User photo urls"
    },
    "do_not_contact": {
      "type": "boolean",
      "description": "User can be contacted ?"
    },
    "mobile_perso": {
      "type": "string",
      "description": "User mobile perso number"
    },
    "mobile_pro": {
      "type": "string",
      "description": "User mobile pro number"
    },
    "landline_perso": {
      "type": "string",
      "description": "User landline perso number"
    },
    "landline_pro": {
      "type": "string",
      "description": "User landline pro number"
    },
    "preferred_phone_number": {
      "type": "string",
      "enum": [
        "mobile_pro",
        "mobile_perso",
        "landline_pro",
        "landline_perso",
        "none"
      ],
      "description": "User preferred phone number"
    },
    "postal_personal": {
      "description": "User personal postal address",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "address_1": {
          "type": "string",
          "description": "Address line 1"
        },
        "address_2": {
          "type": "string",
          "description": "Address line 2"
        },
        "address_3": {
          "type": "string",
          "description": "Address line 3"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "state": {
          "type": "string",
          "description": "State"
        },
        "postal_code": {
          "type": "string",
          "description": "Zip code"
        },
        "country": {
          "type": "string",
          "enum": [
            "TJ",
            "JM",
            "HT",
            "ST",
            "MS",
            "AE",
            "PK",
            "NL",
            "LU",
            "BZ",
            "IR",
            "BO",
            "UY",
            "GH",
            "SA",
            "CI",
            "MF",
            "TF",
            "AI",
            "QA",
            "SX",
            "LY",
            "BV",
            "PG",
            "KG",
            "GQ",
            "EH",
            "NU",
            "PR",
            "GD",
            "KR",
            "HM",
            "SM",
            "SL",
            "CD",
            "MK",
            "TR",
            "DZ",
            "GE",
            "PS",
            "BB",
            "UA",
            "GP",
            "PF",
            "NA",
            "BW",
            "SY",
            "TG",
            "DO",
            "AQ",
            "CH",
            "MG",
            "FO",
            "VG",
            "GI",
            "BN",
            "LA",
            "IS",
            "EE",
            "UM",
            "LT",
            "RS",
            "MR",
            "AD",
            "HU",
            "TK",
            "MY",
            "AO",
            "CV",
            "NF",
            "PA",
            "GW",
            "BE",
            "PT",
            "GB",
            "IM",
            "US",
            "YE",
            "HK",
            "AZ",
            "CC",
            "ML",
            "SK",
            "VU",
            "TL",
            "HR",
            "SR",
            "MU",
            "CZ",
            "PM",
            "LS",
            "WS",
            "KM",
            "IT",
            "BI",
            "WF",
            "GN",
            "SG",
            "CO",
            "CN",
            "AW",
            "MA",
            "FI",
            "VA",
            "ZW",
            "KY",
            "BH",
            "PY",
            "EC",
            "LR",
            "RU",
            "PL",
            "OM",
            "MT",
            "SS",
            "DE",
            "TM",
            "SJ",
            "MM",
            "TT",
            "IL",
            "BD",
            "NR",
            "LK",
            "UG",
            "NG",
            "BQ",
            "MX",
            "CW",
            "SI",
            "MN",
            "CA",
            "AX",
            "VN",
            "TW",
            "JP",
            "IO",
            "RO",
            "BG",
            "GU",
            "BR",
            "AM",
            "ZM",
            "DJ",
            "JE",
            "AT",
            "CM",
            "SE",
            "FJ",
            "KZ",
            "GL",
            "GY",
            "CX",
            "MW",
            "TN",
            "ZA",
            "TO",
            "CY",
            "MV",
            "PN",
            "RW",
            "NI",
            "KN",
            "BJ",
            "ET",
            "GM",
            "TZ",
            "VC",
            "FK",
            "SD",
            "MC",
            "AU",
            "CL",
            "DK",
            "FR",
            "TC",
            "CU",
            "AL",
            "MZ",
            "BS",
            "NE",
            "GT",
            "LI",
            "NP",
            "BF",
            "PW",
            "KW",
            "IN",
            "GA",
            "TV",
            "MO",
            "SH",
            "MD",
            "CK",
            "AR",
            "SC",
            "IE",
            "ES",
            "LB",
            "BM",
            "RE",
            "KI",
            "AG",
            "MQ",
            "SV",
            "JO",
            "TH",
            "SO",
            "MH",
            "CG",
            "KP",
            "GF",
            "BA",
            "YT",
            "GS",
            "KE",
            "PE",
            "BT",
            "SZ",
            "CR",
            "TD",
            "DM",
            "NC",
            "GR",
            "GG",
            "HN",
            "VI",
            "CF",
            "SN",
            "AF",
            "MP",
            "PH",
            "BY",
            "LV",
            "NO",
            "EG",
            "KH",
            "IQ",
            "LC",
            "NZ",
            "BL",
            "UZ",
            "ID",
            "ER",
            "VE",
            "FM",
            "SB",
            "ME",
            "AS",
            "XK"
          ],
          "description": "Country"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "Postal address creation date time - iso8601"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "description": "Postal address last update date time - iso8601"
        }
      }
    },
    "postal_work": {
      "description": "User work postal address",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "address_1": {
          "type": "string",
          "description": "Address line 1"
        },
        "address_2": {
          "type": "string",
          "description": "Address line 2"
        },
        "address_3": {
          "type": "string",
          "description": "Address line 3"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "state": {
          "type": "string",
          "description": "State"
        },
        "postal_code": {
          "type": "string",
          "description": "Zip code"
        },
        "country": {
          "type": "string",
          "enum": [
            "TJ",
            "JM",
            "HT",
            "ST",
            "MS",
            "AE",
            "PK",
            "NL",
            "LU",
            "BZ",
            "IR",
            "BO",
            "UY",
            "GH",
            "SA",
            "CI",
            "MF",
            "TF",
            "AI",
            "QA",
            "SX",
            "LY",
            "BV",
            "PG",
            "KG",
            "GQ",
            "EH",
            "NU",
            "PR",
            "GD",
            "KR",
            "HM",
            "SM",
            "SL",
            "CD",
            "MK",
            "TR",
            "DZ",
            "GE",
            "PS",
            "BB",
            "UA",
            "GP",
            "PF",
            "NA",
            "BW",
            "SY",
            "TG",
            "DO",
            "AQ",
            "CH",
            "MG",
            "FO",
            "VG",
            "GI",
            "BN",
            "LA",
            "IS",
            "EE",
            "UM",
            "LT",
            "RS",
            "MR",
            "AD",
            "HU",
            "TK",
            "MY",
            "AO",
            "CV",
            "NF",
            "PA",
            "GW",
            "BE",
            "PT",
            "GB",
            "IM",
            "US",
            "YE",
            "HK",
            "AZ",
            "CC",
            "ML",
            "SK",
            "VU",
            "TL",
            "HR",
            "SR",
            "MU",
            "CZ",
            "PM",
            "LS",
            "WS",
            "KM",
            "IT",
            "BI",
            "WF",
            "GN",
            "SG",
            "CO",
            "CN",
            "AW",
            "MA",
            "FI",
            "VA",
            "ZW",
            "KY",
            "BH",
            "PY",
            "EC",
            "LR",
            "RU",
            "PL",
            "OM",
            "MT",
            "SS",
            "DE",
            "TM",
            "SJ",
            "MM",
            "TT",
            "IL",
            "BD",
            "NR",
            "LK",
            "UG",
            "NG",
            "BQ",
            "MX",
            "CW",
            "SI",
            "MN",
            "CA",
            "AX",
            "VN",
            "TW",
            "JP",
            "IO",
            "RO",
            "BG",
            "GU",
            "BR",
            "AM",
            "ZM",
            "DJ",
            "JE",
            "AT",
            "CM",
            "SE",
            "FJ",
            "KZ",
            "GL",
            "GY",
            "CX",
            "MW",
            "TN",
            "ZA",
            "TO",
            "CY",
            "MV",
            "PN",
            "RW",
            "NI",
            "KN",
            "BJ",
            "ET",
            "GM",
            "TZ",
            "VC",
            "FK",
            "SD",
            "MC",
            "AU",
            "CL",
            "DK",
            "FR",
            "TC",
            "CU",
            "AL",
            "MZ",
            "BS",
            "NE",
            "GT",
            "LI",
            "NP",
            "BF",
            "PW",
            "KW",
            "IN",
            "GA",
            "TV",
            "MO",
            "SH",
            "MD",
            "CK",
            "AR",
            "SC",
            "IE",
            "ES",
            "LB",
            "BM",
            "RE",
            "KI",
            "AG",
            "MQ",
            "SV",
            "JO",
            "TH",
            "SO",
            "MH",
            "CG",
            "KP",
            "GF",
            "BA",
            "YT",
            "GS",
            "KE",
            "PE",
            "BT",
            "SZ",
            "CR",
            "TD",
            "DM",
            "NC",
            "GR",
            "GG",
            "HN",
            "VI",
            "CF",
            "SN",
            "AF",
            "MP",
            "PH",
            "BY",
            "LV",
            "NO",
            "EG",
            "KH",
            "IQ",
            "LC",
            "NZ",
            "BL",
            "UZ",
            "ID",
            "ER",
            "VE",
            "FM",
            "SB",
            "ME",
            "AS",
            "XK"
          ],
          "description": "Country"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "Postal address creation date time - iso8601"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "description": "Postal address last update date time - iso8601"
        }
      }
    },
    "preferred_postal_address": {
      "type": "string",
      "enum": [
        "postal_personal",
        "postal_work"
      ],
      "description": "User preferred postal address"
    },
    "config": {
      "description": "User specific configuration",
      "type": "object",
      "properties": {
        "private_profile": {
          "type": "boolean",
          "description": "Unique ID"
        },
        "opt_out_of_directory": {
          "type": "boolean",
          "description": "Unique ID"
        },
        "share_gender": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of gender"
        },
        "share_prefix_firstname": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of prefix_firstname"
        },
        "share_honorary_title": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of honorary_title"
        },
        "share_prefix_name": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of prefix_name"
        },
        "share_suffix_name": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of suffix_name"
        },
        "share_maidenname": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of maidenname"
        },
        "share_birthday": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of birthday"
        },
        "share_birthplace": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of birthplace"
        },
        "share_headline": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of headline"
        },
        "share_nationalities": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of nationalities"
        },
        "share_live_location": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of live_location"
        },
        "share_sub_networks": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of sub_networks"
        },
        "share_resume": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of resume"
        },
        "share_summary": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of summary"
        },
        "share_industries": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of industries"
        },
        "share_skills": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of skills"
        },
        "share_facebook_profile_url": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of facebook_profile_url"
        },
        "share_instagram_profile_url": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of instagram_profile_url"
        },
        "share_twitter": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of twitter"
        },
        "share_skype": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of skype"
        },
        "share_linkedin_profile_url": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of linkedin_profile_url"
        },
        "share_website": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of website"
        },
        "share_bbm": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of bbm"
        },
        "share_email": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of email"
        },
        "share_email2": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of email2"
        },
        "share_email3": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of email3"
        },
        "share_mobile_perso": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of mobile_perso"
        },
        "share_landline_perso": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of landline_perso"
        },
        "share_mobile_pro": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of mobile_pro"
        },
        "share_landline_pro": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of landline_pro"
        },
        "share_postal_personal": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of postal_personal"
        },
        "share_postal_work": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of postal_work"
        },
        "share_memberships": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of memberships"
        },
        "share_educations": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of educations"
        },
        "share_experiences": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of experiences"
        }
      }
    },
    "role_id": {
      "type": "integer",
      "format": "int32",
      "description": "User role ID"
    },
    "awards": {
      "type": "string",
      "description": "User awards"
    },
    "linkedin_profile_url": {
      "type": "string",
      "description": "User linkedin profile URL"
    },
    "website": {
      "type": "string",
      "description": "User Website URL"
    },
    "skype": {
      "type": "string",
      "description": "User skype profile"
    },
    "bbm": {
      "type": "string",
      "description": "User BlackBerry Messenger profile"
    },
    "twitter": {
      "type": "string",
      "description": "User twitter profile"
    },
    "timezone": {
      "type": "string",
      "enum": [
        "Africa/Abidjan",
        "Africa/Accra",
        "Africa/Algiers",
        "Africa/Bissau",
        "Africa/Cairo",
        "Africa/Casablanca",
        "Africa/Ceuta",
        "Africa/El_Aaiun",
        "Africa/Johannesburg",
        "Africa/Juba",
        "Africa/Khartoum",
        "Africa/Lagos",
        "Africa/Maputo",
        "Africa/Monrovia",
        "Africa/Nairobi",
        "Africa/Ndjamena",
        "Africa/Sao_Tome",
        "Africa/Tripoli",
        "Africa/Tunis",
        "Africa/Windhoek",
        "America/Adak",
        "America/Anchorage",
        "America/Araguaina",
        "America/Argentina/Buenos_Aires",
        "America/Argentina/Catamarca",
        "America/Argentina/Cordoba",
        "America/Argentina/Jujuy",
        "America/Argentina/La_Rioja",
        "America/Argentina/Mendoza",
        "America/Argentina/Rio_Gallegos",
        "America/Argentina/Salta",
        "America/Argentina/San_Juan",
        "America/Argentina/San_Luis",
        "America/Argentina/Tucuman",
        "America/Argentina/Ushuaia",
        "America/Asuncion",
        "America/Atikokan",
        "America/Bahia",
        "America/Bahia_Banderas",
        "America/Barbados",
        "America/Belem",
        "America/Belize",
        "America/Blanc-Sablon",
        "America/Boa_Vista",
        "America/Bogota",
        "America/Boise",
        "America/Cambridge_Bay",
        "America/Campo_Grande",
        "America/Cancun",
        "America/Caracas",
        "America/Cayenne",
        "America/Chicago",
        "America/Chihuahua",
        "America/Costa_Rica",
        "America/Creston",
        "America/Cuiaba",
        "America/Curacao",
        "America/Danmarkshavn",
        "America/Dawson",
        "America/Dawson_Creek",
        "America/Denver",
        "America/Detroit",
        "America/Edmonton",
        "America/Eirunepe",
        "America/El_Salvador",
        "America/Fort_Nelson",
        "America/Fortaleza",
        "America/Glace_Bay",
        "America/Goose_Bay",
        "America/Grand_Turk",
        "America/Guatemala",
        "America/Guayaquil",
        "America/Guyana",
        "America/Halifax",
        "America/Havana",
        "America/Hermosillo",
        "America/Indiana/Indianapolis",
        "America/Indiana/Knox",
        "America/Indiana/Marengo",
        "America/Indiana/Petersburg",
        "America/Indiana/Tell_City",
        "America/Indiana/Vevay",
        "America/Indiana/Vincennes",
        "America/Indiana/Winamac",
        "America/Inuvik",
        "America/Iqaluit",
        "America/Jamaica",
        "America/Juneau",
        "America/Kentucky/Louisville",
        "America/Kentucky/Monticello",
        "America/La_Paz",
        "America/Lima",
        "America/Los_Angeles",
        "America/Maceio",
        "America/Managua",
        "America/Manaus",
        "America/Martinique",
        "America/Matamoros",
        "America/Mazatlan",
        "America/Menominee",
        "America/Merida",
        "America/Metlakatla",
        "America/Mexico_City",
        "America/Miquelon",
        "America/Moncton",
        "America/Monterrey",
        "America/Montevideo",
        "America/Nassau",
        "America/New_York",
        "America/Nipigon",
        "America/Nome",
        "America/Noronha",
        "America/North_Dakota/Beulah",
        "America/North_Dakota/Center",
        "America/North_Dakota/New_Salem",
        "America/Nuuk",
        "America/Ojinaga",
        "America/Panama",
        "America/Pangnirtung",
        "America/Paramaribo",
        "America/Phoenix",
        "America/Port-au-Prince",
        "America/Port_of_Spain",
        "America/Porto_Velho",
        "America/Puerto_Rico",
        "America/Punta_Arenas",
        "America/Rainy_River",
        "America/Rankin_Inlet",
        "America/Recife",
        "America/Regina",
        "America/Resolute",
        "America/Rio_Branco",
        "America/Santarem",
        "America/Santiago",
        "America/Santo_Domingo",
        "America/Sao_Paulo",
        "America/Scoresbysund",
        "America/Sitka",
        "America/St_Johns",
        "America/Swift_Current",
        "America/Tegucigalpa",
        "America/Thule",
        "America/Thunder_Bay",
        "America/Tijuana",
        "America/Toronto",
        "America/Vancouver",
        "America/Whitehorse",
        "America/Winnipeg",
        "America/Yakutat",
        "America/Yellowknife",
        "Antarctica/Casey",
        "Antarctica/Davis",
        "Antarctica/DumontDUrville",
        "Antarctica/Macquarie",
        "Antarctica/Mawson",
        "Antarctica/Palmer",
        "Antarctica/Rothera",
        "Antarctica/Syowa",
        "Antarctica/Troll",
        "Antarctica/Vostok",
        "Asia/Almaty",
        "Asia/Amman",
        "Asia/Anadyr",
        "Asia/Aqtau",
        "Asia/Aqtobe",
        "Asia/Ashgabat",
        "Asia/Atyrau",
        "Asia/Baghdad",
        "Asia/Baku",
        "Asia/Bangkok",
        "Asia/Barnaul",
        "Asia/Beirut",
        "Asia/Bishkek",
        "Asia/Brunei",
        "Asia/Chita",
        "Asia/Choibalsan",
        "Asia/Colombo",
        "Asia/Damascus",
        "Asia/Dhaka",
        "Asia/Dili",
        "Asia/Dubai",
        "Asia/Dushanbe",
        "Asia/Famagusta",
        "Asia/Gaza",
        "Asia/Hebron",
        "Asia/Ho_Chi_Minh",
        "Asia/Hong_Kong",
        "Asia/Hovd",
        "Asia/Irkutsk",
        "Asia/Jakarta",
        "Asia/Jayapura",
        "Asia/Jerusalem",
        "Asia/Kabul",
        "Asia/Kamchatka",
        "Asia/Karachi",
        "Asia/Kathmandu",
        "Asia/Khandyga",
        "Asia/Kolkata",
        "Asia/Krasnoyarsk",
        "Asia/Kuala_Lumpur",
        "Asia/Kuching",
        "Asia/Macau",
        "Asia/Magadan",
        "Asia/Makassar",
        "Asia/Manila",
        "Asia/Nicosia",
        "Asia/Novokuznetsk",
        "Asia/Novosibirsk",
        "Asia/Omsk",
        "Asia/Oral",
        "Asia/Pontianak",
        "Asia/Pyongyang",
        "Asia/Qatar",
        "Asia/Qostanay",
        "Asia/Qyzylorda",
        "Asia/Riyadh",
        "Asia/Sakhalin",
        "Asia/Samarkand",
        "Asia/Seoul",
        "Asia/Shanghai",
        "Asia/Singapore",
        "Asia/Srednekolymsk",
        "Asia/Taipei",
        "Asia/Tashkent",
        "Asia/Tbilisi",
        "Asia/Tehran",
        "Asia/Thimphu",
        "Asia/Tokyo",
        "Asia/Tomsk",
        "Asia/Ulaanbaatar",
        "Asia/Urumqi",
        "Asia/Ust-Nera",
        "Asia/Vladivostok",
        "Asia/Yakutsk",
        "Asia/Yangon",
        "Asia/Yekaterinburg",
        "Asia/Yerevan",
        "Atlantic/Azores",
        "Atlantic/Bermuda",
        "Atlantic/Canary",
        "Atlantic/Cape_Verde",
        "Atlantic/Faroe",
        "Atlantic/Madeira",
        "Atlantic/Reykjavik",
        "Atlantic/South_Georgia",
        "Atlantic/Stanley",
        "Australia/Adelaide",
        "Australia/Brisbane",
        "Australia/Broken_Hill",
        "Australia/Currie",
        "Australia/Darwin",
        "Australia/Eucla",
        "Australia/Hobart",
        "Australia/Lindeman",
        "Australia/Lord_Howe",
        "Australia/Melbourne",
        "Australia/Perth",
        "Australia/Sydney",
        "CET",
        "CST6CDT",
        "EET",
        "EST",
        "EST5EDT",
        "Etc/GMT",
        "Etc/GMT+1",
        "Etc/GMT+10",
        "Etc/GMT+11",
        "Etc/GMT+12",
        "Etc/GMT+2",
        "Etc/GMT+3",
        "Etc/GMT+4",
        "Etc/GMT+5",
        "Etc/GMT+6",
        "Etc/GMT+7",
        "Etc/GMT+8",
        "Etc/GMT+9",
        "Etc/GMT-1",
        "Etc/GMT-10",
        "Etc/GMT-11",
        "Etc/GMT-12",
        "Etc/GMT-13",
        "Etc/GMT-14",
        "Etc/GMT-2",
        "Etc/GMT-3",
        "Etc/GMT-4",
        "Etc/GMT-5",
        "Etc/GMT-6",
        "Etc/GMT-7",
        "Etc/GMT-8",
        "Etc/GMT-9",
        "Etc/UTC",
        "Europe/Amsterdam",
        "Europe/Andorra",
        "Europe/Astrakhan",
        "Europe/Athens",
        "Europe/Belgrade",
        "Europe/Berlin",
        "Europe/Brussels",
        "Europe/Bucharest",
        "Europe/Budapest",
        "Europe/Chisinau",
        "Europe/Copenhagen",
        "Europe/Dublin",
        "Europe/Gibraltar",
        "Europe/Helsinki",
        "Europe/Istanbul",
        "Europe/Kaliningrad",
        "Europe/Kiev",
        "Europe/Kirov",
        "Europe/Lisbon",
        "Europe/London",
        "Europe/Luxembourg",
        "Europe/Madrid",
        "Europe/Malta",
        "Europe/Minsk",
        "Europe/Monaco",
        "Europe/Moscow",
        "Europe/Oslo",
        "Europe/Paris",
        "Europe/Prague",
        "Europe/Riga",
        "Europe/Rome",
        "Europe/Samara",
        "Europe/Saratov",
        "Europe/Simferopol",
        "Europe/Sofia",
        "Europe/Stockholm",
        "Europe/Tallinn",
        "Europe/Tirane",
        "Europe/Ulyanovsk",
        "Europe/Uzhgorod",
        "Europe/Vienna",
        "Europe/Vilnius",
        "Europe/Volgograd",
        "Europe/Warsaw",
        "Europe/Zaporozhye",
        "Europe/Zurich",
        "Factory",
        "HST",
        "Indian/Chagos",
        "Indian/Christmas",
        "Indian/Cocos",
        "Indian/Kerguelen",
        "Indian/Mahe",
        "Indian/Maldives",
        "Indian/Mauritius",
        "Indian/Reunion",
        "MET",
        "MST",
        "MST7MDT",
        "PST8PDT",
        "Pacific/Apia",
        "Pacific/Auckland",
        "Pacific/Bougainville",
        "Pacific/Chatham",
        "Pacific/Chuuk",
        "Pacific/Easter",
        "Pacific/Efate",
        "Pacific/Enderbury",
        "Pacific/Fakaofo",
        "Pacific/Fiji",
        "Pacific/Funafuti",
        "Pacific/Galapagos",
        "Pacific/Gambier",
        "Pacific/Guadalcanal",
        "Pacific/Guam",
        "Pacific/Honolulu",
        "Pacific/Kiritimati",
        "Pacific/Kosrae",
        "Pacific/Kwajalein",
        "Pacific/Majuro",
        "Pacific/Marquesas",
        "Pacific/Nauru",
        "Pacific/Niue",
        "Pacific/Norfolk",
        "Pacific/Noumea",
        "Pacific/Pago_Pago",
        "Pacific/Palau",
        "Pacific/Pitcairn",
        "Pacific/Pohnpei",
        "Pacific/Port_Moresby",
        "Pacific/Rarotonga",
        "Pacific/Tahiti",
        "Pacific/Tarawa",
        "Pacific/Tongatapu",
        "Pacific/Wake",
        "Pacific/Wallis",
        "WET"
      ],
      "description": "User timezone"
    },
    "facebook_profile_url": {
      "type": "string",
      "description": "User facebook profile URL"
    },
    "instagram_profile_url": {
      "type": "string",
      "description": "User instagram profile URL"
    },
    "honorary_title": {
      "type": "string",
      "enum": [
        "mr",
        "mrs",
        "ms",
        "dr",
        "prof"
      ],
      "description": "User's honorary title"
    },
    "live_location": {
      "description": "User's current location. READ only, can't be updated",
      "type": "object",
      "properties": {
        "address": {
          "type": "string",
          "description": "Address"
        },
        "lat": {
          "type": "number",
          "format": "float",
          "description": "Latitude"
        },
        "lng": {
          "type": "number",
          "format": "float",
          "description": "Longitude"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "State"
        },
        "country_code": {
          "type": "string",
          "description": "Zip code"
        }
      }
    },
    "resume": {
      "type": "string",
      "description": "URL link to the user's resume"
    },
    "locale": {
      "type": "string",
      "enum": [
        "en",
        "en-GB",
        "fr",
        "he",
        "de",
        "es",
        "it",
        "da",
        "nl",
        "pt",
        "ru",
        "deepbloo",
        "zh-Hans",
        "zh-Hant",
        "af",
        "pl",
        "fi",
        "nl-BE",
        "nb"
      ],
      "description": "User Locale"
    },
    "share_email": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding email"
    },
    "share_email2": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding secondary email"
    },
    "share_email3": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding complementary email"
    },
    "share_postal_address_personal": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding postal home location"
    },
    "share_postal_address_work": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding postal work location"
    },
    "share_nationalities": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding nationalities"
    },
    "share_resume": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding resume"
    },
    "share_mobile_pro": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding work mobile phone"
    },
    "share_mobile_perso": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding personal mobile phone"
    },
    "share_landline_pro": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding professional landline phone"
    },
    "share_landline_perso": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding personal landline phone"
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Array of customizable attributes with name, value and type"
    }
  },
  "description": "User model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Update existing user
PUT/api/admin/v1/users/{id}

Update the user profile

Find the user matching this ID, or use external_id or previous_id as the key parameter to fetch the user on one of these identifier instead of default ID. Photo and resume must be sent as files (URL to files won’t work)

URI Parameters
id
string (required) 

User ID


GET /api/admin/v1/users/id?key=
Responses200

Get user profile

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "email": {
      "type": "string",
      "description": "User email"
    },
    "name": {
      "type": "string",
      "description": "User full name"
    },
    "sub_network_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "IDs list of user sub networks"
    },
    "extended_updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
    },
    "email2": {
      "type": "string",
      "description": "User secondary email"
    },
    "email3": {
      "type": "string",
      "description": "User complementary email"
    },
    "primary_email_choice": {
      "type": "string",
      "enum": [
        "email",
        "email2",
        "email3"
      ],
      "description": "User primary email choice"
    },
    "firstname": {
      "type": "string",
      "description": "User first name"
    },
    "lastname": {
      "type": "string",
      "description": "User last name"
    },
    "maidenname": {
      "type": "string",
      "description": "User maiden name"
    },
    "prefix_firstname": {
      "type": "string",
      "description": "User prefix firstname"
    },
    "prefix_name": {
      "type": "string",
      "description": "User prefix name"
    },
    "suffix_name": {
      "type": "string",
      "description": "User suffix name"
    },
    "external_id": {
      "type": "string",
      "description": "User ID in your database"
    },
    "sso_identifier": {
      "type": "string",
      "description": "User identifier for SSO"
    },
    "previous_id": {
      "type": "string",
      "description": "User ID in your community system"
    },
    "is_active": {
      "type": "boolean",
      "description": "User account enabled ?"
    },
    "gender": {
      "type": "string",
      "enum": [
        "male",
        "female",
        "other"
      ],
      "description": "User gender (male/female/other)"
    },
    "birthday": {
      "type": "string",
      "format": "date",
      "description": "User birth date"
    },
    "birthplace": {
      "type": "string",
      "description": "User birth place"
    },
    "headline": {
      "type": "string",
      "description": "User headline"
    },
    "summary": {
      "type": "string",
      "description": "User summary"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "User creation date time - iso8601. READ only, can't be updated"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "User last update date time - iso8601. READ only, can't be updated"
    },
    "confirmed_at": {
      "type": "string",
      "format": "date-time",
      "description": "User activation date time - iso8601. READ only, can't be updated"
    },
    "citizenship_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "List of citizenship IDs"
    },
    "citizenship_country_codes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of ISO-3166-2 citizenship country codes"
    },
    "deceased": {
      "type": "boolean",
      "description": "User deceased ?"
    },
    "deceased_at": {
      "type": "string",
      "format": "date-time",
      "description": "User decease date time - iso8601."
    },
    "photo": {
      "type": "object",
      "properties": {
        "large-url": {
          "type": "string",
          "description": "User large photo url"
        },
        "medium-url": {
          "type": "string",
          "description": "User medium photo url"
        },
        "thumb-url": {
          "type": "string",
          "description": "User thumb photo url"
        },
        "mini-url": {
          "type": "string",
          "description": "User mini photo url"
        },
        "friend-url": {
          "type": "string",
          "description": "User friend photo url"
        },
        "icon-url": {
          "type": "string",
          "description": "User icon photo url"
        }
      },
      "description": "User photo urls"
    },
    "do_not_contact": {
      "type": "boolean",
      "description": "User can be contacted ?"
    },
    "mobile_perso": {
      "type": "string",
      "description": "User mobile perso number"
    },
    "mobile_pro": {
      "type": "string",
      "description": "User mobile pro number"
    },
    "landline_perso": {
      "type": "string",
      "description": "User landline perso number"
    },
    "landline_pro": {
      "type": "string",
      "description": "User landline pro number"
    },
    "preferred_phone_number": {
      "type": "string",
      "enum": [
        "mobile_pro",
        "mobile_perso",
        "landline_pro",
        "landline_perso",
        "none"
      ],
      "description": "User preferred phone number"
    },
    "postal_personal": {
      "description": "User personal postal address",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "address_1": {
          "type": "string",
          "description": "Address line 1"
        },
        "address_2": {
          "type": "string",
          "description": "Address line 2"
        },
        "address_3": {
          "type": "string",
          "description": "Address line 3"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "state": {
          "type": "string",
          "description": "State"
        },
        "postal_code": {
          "type": "string",
          "description": "Zip code"
        },
        "country": {
          "type": "string",
          "enum": [
            "TJ",
            "JM",
            "HT",
            "ST",
            "MS",
            "AE",
            "PK",
            "NL",
            "LU",
            "BZ",
            "IR",
            "BO",
            "UY",
            "GH",
            "SA",
            "CI",
            "MF",
            "TF",
            "AI",
            "QA",
            "SX",
            "LY",
            "BV",
            "PG",
            "KG",
            "GQ",
            "EH",
            "NU",
            "PR",
            "GD",
            "KR",
            "HM",
            "SM",
            "SL",
            "CD",
            "MK",
            "TR",
            "DZ",
            "GE",
            "PS",
            "BB",
            "UA",
            "GP",
            "PF",
            "NA",
            "BW",
            "SY",
            "TG",
            "DO",
            "AQ",
            "CH",
            "MG",
            "FO",
            "VG",
            "GI",
            "BN",
            "LA",
            "IS",
            "EE",
            "UM",
            "LT",
            "RS",
            "MR",
            "AD",
            "HU",
            "TK",
            "MY",
            "AO",
            "CV",
            "NF",
            "PA",
            "GW",
            "BE",
            "PT",
            "GB",
            "IM",
            "US",
            "YE",
            "HK",
            "AZ",
            "CC",
            "ML",
            "SK",
            "VU",
            "TL",
            "HR",
            "SR",
            "MU",
            "CZ",
            "PM",
            "LS",
            "WS",
            "KM",
            "IT",
            "BI",
            "WF",
            "GN",
            "SG",
            "CO",
            "CN",
            "AW",
            "MA",
            "FI",
            "VA",
            "ZW",
            "KY",
            "BH",
            "PY",
            "EC",
            "LR",
            "RU",
            "PL",
            "OM",
            "MT",
            "SS",
            "DE",
            "TM",
            "SJ",
            "MM",
            "TT",
            "IL",
            "BD",
            "NR",
            "LK",
            "UG",
            "NG",
            "BQ",
            "MX",
            "CW",
            "SI",
            "MN",
            "CA",
            "AX",
            "VN",
            "TW",
            "JP",
            "IO",
            "RO",
            "BG",
            "GU",
            "BR",
            "AM",
            "ZM",
            "DJ",
            "JE",
            "AT",
            "CM",
            "SE",
            "FJ",
            "KZ",
            "GL",
            "GY",
            "CX",
            "MW",
            "TN",
            "ZA",
            "TO",
            "CY",
            "MV",
            "PN",
            "RW",
            "NI",
            "KN",
            "BJ",
            "ET",
            "GM",
            "TZ",
            "VC",
            "FK",
            "SD",
            "MC",
            "AU",
            "CL",
            "DK",
            "FR",
            "TC",
            "CU",
            "AL",
            "MZ",
            "BS",
            "NE",
            "GT",
            "LI",
            "NP",
            "BF",
            "PW",
            "KW",
            "IN",
            "GA",
            "TV",
            "MO",
            "SH",
            "MD",
            "CK",
            "AR",
            "SC",
            "IE",
            "ES",
            "LB",
            "BM",
            "RE",
            "KI",
            "AG",
            "MQ",
            "SV",
            "JO",
            "TH",
            "SO",
            "MH",
            "CG",
            "KP",
            "GF",
            "BA",
            "YT",
            "GS",
            "KE",
            "PE",
            "BT",
            "SZ",
            "CR",
            "TD",
            "DM",
            "NC",
            "GR",
            "GG",
            "HN",
            "VI",
            "CF",
            "SN",
            "AF",
            "MP",
            "PH",
            "BY",
            "LV",
            "NO",
            "EG",
            "KH",
            "IQ",
            "LC",
            "NZ",
            "BL",
            "UZ",
            "ID",
            "ER",
            "VE",
            "FM",
            "SB",
            "ME",
            "AS",
            "XK"
          ],
          "description": "Country"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "Postal address creation date time - iso8601"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "description": "Postal address last update date time - iso8601"
        }
      }
    },
    "postal_work": {
      "description": "User work postal address",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "address_1": {
          "type": "string",
          "description": "Address line 1"
        },
        "address_2": {
          "type": "string",
          "description": "Address line 2"
        },
        "address_3": {
          "type": "string",
          "description": "Address line 3"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "state": {
          "type": "string",
          "description": "State"
        },
        "postal_code": {
          "type": "string",
          "description": "Zip code"
        },
        "country": {
          "type": "string",
          "enum": [
            "TJ",
            "JM",
            "HT",
            "ST",
            "MS",
            "AE",
            "PK",
            "NL",
            "LU",
            "BZ",
            "IR",
            "BO",
            "UY",
            "GH",
            "SA",
            "CI",
            "MF",
            "TF",
            "AI",
            "QA",
            "SX",
            "LY",
            "BV",
            "PG",
            "KG",
            "GQ",
            "EH",
            "NU",
            "PR",
            "GD",
            "KR",
            "HM",
            "SM",
            "SL",
            "CD",
            "MK",
            "TR",
            "DZ",
            "GE",
            "PS",
            "BB",
            "UA",
            "GP",
            "PF",
            "NA",
            "BW",
            "SY",
            "TG",
            "DO",
            "AQ",
            "CH",
            "MG",
            "FO",
            "VG",
            "GI",
            "BN",
            "LA",
            "IS",
            "EE",
            "UM",
            "LT",
            "RS",
            "MR",
            "AD",
            "HU",
            "TK",
            "MY",
            "AO",
            "CV",
            "NF",
            "PA",
            "GW",
            "BE",
            "PT",
            "GB",
            "IM",
            "US",
            "YE",
            "HK",
            "AZ",
            "CC",
            "ML",
            "SK",
            "VU",
            "TL",
            "HR",
            "SR",
            "MU",
            "CZ",
            "PM",
            "LS",
            "WS",
            "KM",
            "IT",
            "BI",
            "WF",
            "GN",
            "SG",
            "CO",
            "CN",
            "AW",
            "MA",
            "FI",
            "VA",
            "ZW",
            "KY",
            "BH",
            "PY",
            "EC",
            "LR",
            "RU",
            "PL",
            "OM",
            "MT",
            "SS",
            "DE",
            "TM",
            "SJ",
            "MM",
            "TT",
            "IL",
            "BD",
            "NR",
            "LK",
            "UG",
            "NG",
            "BQ",
            "MX",
            "CW",
            "SI",
            "MN",
            "CA",
            "AX",
            "VN",
            "TW",
            "JP",
            "IO",
            "RO",
            "BG",
            "GU",
            "BR",
            "AM",
            "ZM",
            "DJ",
            "JE",
            "AT",
            "CM",
            "SE",
            "FJ",
            "KZ",
            "GL",
            "GY",
            "CX",
            "MW",
            "TN",
            "ZA",
            "TO",
            "CY",
            "MV",
            "PN",
            "RW",
            "NI",
            "KN",
            "BJ",
            "ET",
            "GM",
            "TZ",
            "VC",
            "FK",
            "SD",
            "MC",
            "AU",
            "CL",
            "DK",
            "FR",
            "TC",
            "CU",
            "AL",
            "MZ",
            "BS",
            "NE",
            "GT",
            "LI",
            "NP",
            "BF",
            "PW",
            "KW",
            "IN",
            "GA",
            "TV",
            "MO",
            "SH",
            "MD",
            "CK",
            "AR",
            "SC",
            "IE",
            "ES",
            "LB",
            "BM",
            "RE",
            "KI",
            "AG",
            "MQ",
            "SV",
            "JO",
            "TH",
            "SO",
            "MH",
            "CG",
            "KP",
            "GF",
            "BA",
            "YT",
            "GS",
            "KE",
            "PE",
            "BT",
            "SZ",
            "CR",
            "TD",
            "DM",
            "NC",
            "GR",
            "GG",
            "HN",
            "VI",
            "CF",
            "SN",
            "AF",
            "MP",
            "PH",
            "BY",
            "LV",
            "NO",
            "EG",
            "KH",
            "IQ",
            "LC",
            "NZ",
            "BL",
            "UZ",
            "ID",
            "ER",
            "VE",
            "FM",
            "SB",
            "ME",
            "AS",
            "XK"
          ],
          "description": "Country"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "Postal address creation date time - iso8601"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "description": "Postal address last update date time - iso8601"
        }
      }
    },
    "preferred_postal_address": {
      "type": "string",
      "enum": [
        "postal_personal",
        "postal_work"
      ],
      "description": "User preferred postal address"
    },
    "config": {
      "description": "User specific configuration",
      "type": "object",
      "properties": {
        "private_profile": {
          "type": "boolean",
          "description": "Unique ID"
        },
        "opt_out_of_directory": {
          "type": "boolean",
          "description": "Unique ID"
        },
        "share_gender": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of gender"
        },
        "share_prefix_firstname": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of prefix_firstname"
        },
        "share_honorary_title": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of honorary_title"
        },
        "share_prefix_name": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of prefix_name"
        },
        "share_suffix_name": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of suffix_name"
        },
        "share_maidenname": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of maidenname"
        },
        "share_birthday": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of birthday"
        },
        "share_birthplace": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of birthplace"
        },
        "share_headline": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of headline"
        },
        "share_nationalities": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of nationalities"
        },
        "share_live_location": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of live_location"
        },
        "share_sub_networks": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of sub_networks"
        },
        "share_resume": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of resume"
        },
        "share_summary": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of summary"
        },
        "share_industries": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of industries"
        },
        "share_skills": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of skills"
        },
        "share_facebook_profile_url": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of facebook_profile_url"
        },
        "share_instagram_profile_url": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of instagram_profile_url"
        },
        "share_twitter": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of twitter"
        },
        "share_skype": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of skype"
        },
        "share_linkedin_profile_url": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of linkedin_profile_url"
        },
        "share_website": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of website"
        },
        "share_bbm": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of bbm"
        },
        "share_email": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of email"
        },
        "share_email2": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of email2"
        },
        "share_email3": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of email3"
        },
        "share_mobile_perso": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of mobile_perso"
        },
        "share_landline_perso": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of landline_perso"
        },
        "share_mobile_pro": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of mobile_pro"
        },
        "share_landline_pro": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of landline_pro"
        },
        "share_postal_personal": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of postal_personal"
        },
        "share_postal_work": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of postal_work"
        },
        "share_memberships": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of memberships"
        },
        "share_educations": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of educations"
        },
        "share_experiences": {
          "type": "string",
          "enum": [
            "with_admin",
            "with_all",
            "with_bookmarked_users"
          ],
          "description": "Privacy sharing status of experiences"
        }
      }
    },
    "role_id": {
      "type": "integer",
      "format": "int32",
      "description": "User role ID"
    },
    "awards": {
      "type": "string",
      "description": "User awards"
    },
    "linkedin_profile_url": {
      "type": "string",
      "description": "User linkedin profile URL"
    },
    "website": {
      "type": "string",
      "description": "User Website URL"
    },
    "skype": {
      "type": "string",
      "description": "User skype profile"
    },
    "bbm": {
      "type": "string",
      "description": "User BlackBerry Messenger profile"
    },
    "twitter": {
      "type": "string",
      "description": "User twitter profile"
    },
    "timezone": {
      "type": "string",
      "enum": [
        "Africa/Abidjan",
        "Africa/Accra",
        "Africa/Algiers",
        "Africa/Bissau",
        "Africa/Cairo",
        "Africa/Casablanca",
        "Africa/Ceuta",
        "Africa/El_Aaiun",
        "Africa/Johannesburg",
        "Africa/Juba",
        "Africa/Khartoum",
        "Africa/Lagos",
        "Africa/Maputo",
        "Africa/Monrovia",
        "Africa/Nairobi",
        "Africa/Ndjamena",
        "Africa/Sao_Tome",
        "Africa/Tripoli",
        "Africa/Tunis",
        "Africa/Windhoek",
        "America/Adak",
        "America/Anchorage",
        "America/Araguaina",
        "America/Argentina/Buenos_Aires",
        "America/Argentina/Catamarca",
        "America/Argentina/Cordoba",
        "America/Argentina/Jujuy",
        "America/Argentina/La_Rioja",
        "America/Argentina/Mendoza",
        "America/Argentina/Rio_Gallegos",
        "America/Argentina/Salta",
        "America/Argentina/San_Juan",
        "America/Argentina/San_Luis",
        "America/Argentina/Tucuman",
        "America/Argentina/Ushuaia",
        "America/Asuncion",
        "America/Atikokan",
        "America/Bahia",
        "America/Bahia_Banderas",
        "America/Barbados",
        "America/Belem",
        "America/Belize",
        "America/Blanc-Sablon",
        "America/Boa_Vista",
        "America/Bogota",
        "America/Boise",
        "America/Cambridge_Bay",
        "America/Campo_Grande",
        "America/Cancun",
        "America/Caracas",
        "America/Cayenne",
        "America/Chicago",
        "America/Chihuahua",
        "America/Costa_Rica",
        "America/Creston",
        "America/Cuiaba",
        "America/Curacao",
        "America/Danmarkshavn",
        "America/Dawson",
        "America/Dawson_Creek",
        "America/Denver",
        "America/Detroit",
        "America/Edmonton",
        "America/Eirunepe",
        "America/El_Salvador",
        "America/Fort_Nelson",
        "America/Fortaleza",
        "America/Glace_Bay",
        "America/Goose_Bay",
        "America/Grand_Turk",
        "America/Guatemala",
        "America/Guayaquil",
        "America/Guyana",
        "America/Halifax",
        "America/Havana",
        "America/Hermosillo",
        "America/Indiana/Indianapolis",
        "America/Indiana/Knox",
        "America/Indiana/Marengo",
        "America/Indiana/Petersburg",
        "America/Indiana/Tell_City",
        "America/Indiana/Vevay",
        "America/Indiana/Vincennes",
        "America/Indiana/Winamac",
        "America/Inuvik",
        "America/Iqaluit",
        "America/Jamaica",
        "America/Juneau",
        "America/Kentucky/Louisville",
        "America/Kentucky/Monticello",
        "America/La_Paz",
        "America/Lima",
        "America/Los_Angeles",
        "America/Maceio",
        "America/Managua",
        "America/Manaus",
        "America/Martinique",
        "America/Matamoros",
        "America/Mazatlan",
        "America/Menominee",
        "America/Merida",
        "America/Metlakatla",
        "America/Mexico_City",
        "America/Miquelon",
        "America/Moncton",
        "America/Monterrey",
        "America/Montevideo",
        "America/Nassau",
        "America/New_York",
        "America/Nipigon",
        "America/Nome",
        "America/Noronha",
        "America/North_Dakota/Beulah",
        "America/North_Dakota/Center",
        "America/North_Dakota/New_Salem",
        "America/Nuuk",
        "America/Ojinaga",
        "America/Panama",
        "America/Pangnirtung",
        "America/Paramaribo",
        "America/Phoenix",
        "America/Port-au-Prince",
        "America/Port_of_Spain",
        "America/Porto_Velho",
        "America/Puerto_Rico",
        "America/Punta_Arenas",
        "America/Rainy_River",
        "America/Rankin_Inlet",
        "America/Recife",
        "America/Regina",
        "America/Resolute",
        "America/Rio_Branco",
        "America/Santarem",
        "America/Santiago",
        "America/Santo_Domingo",
        "America/Sao_Paulo",
        "America/Scoresbysund",
        "America/Sitka",
        "America/St_Johns",
        "America/Swift_Current",
        "America/Tegucigalpa",
        "America/Thule",
        "America/Thunder_Bay",
        "America/Tijuana",
        "America/Toronto",
        "America/Vancouver",
        "America/Whitehorse",
        "America/Winnipeg",
        "America/Yakutat",
        "America/Yellowknife",
        "Antarctica/Casey",
        "Antarctica/Davis",
        "Antarctica/DumontDUrville",
        "Antarctica/Macquarie",
        "Antarctica/Mawson",
        "Antarctica/Palmer",
        "Antarctica/Rothera",
        "Antarctica/Syowa",
        "Antarctica/Troll",
        "Antarctica/Vostok",
        "Asia/Almaty",
        "Asia/Amman",
        "Asia/Anadyr",
        "Asia/Aqtau",
        "Asia/Aqtobe",
        "Asia/Ashgabat",
        "Asia/Atyrau",
        "Asia/Baghdad",
        "Asia/Baku",
        "Asia/Bangkok",
        "Asia/Barnaul",
        "Asia/Beirut",
        "Asia/Bishkek",
        "Asia/Brunei",
        "Asia/Chita",
        "Asia/Choibalsan",
        "Asia/Colombo",
        "Asia/Damascus",
        "Asia/Dhaka",
        "Asia/Dili",
        "Asia/Dubai",
        "Asia/Dushanbe",
        "Asia/Famagusta",
        "Asia/Gaza",
        "Asia/Hebron",
        "Asia/Ho_Chi_Minh",
        "Asia/Hong_Kong",
        "Asia/Hovd",
        "Asia/Irkutsk",
        "Asia/Jakarta",
        "Asia/Jayapura",
        "Asia/Jerusalem",
        "Asia/Kabul",
        "Asia/Kamchatka",
        "Asia/Karachi",
        "Asia/Kathmandu",
        "Asia/Khandyga",
        "Asia/Kolkata",
        "Asia/Krasnoyarsk",
        "Asia/Kuala_Lumpur",
        "Asia/Kuching",
        "Asia/Macau",
        "Asia/Magadan",
        "Asia/Makassar",
        "Asia/Manila",
        "Asia/Nicosia",
        "Asia/Novokuznetsk",
        "Asia/Novosibirsk",
        "Asia/Omsk",
        "Asia/Oral",
        "Asia/Pontianak",
        "Asia/Pyongyang",
        "Asia/Qatar",
        "Asia/Qostanay",
        "Asia/Qyzylorda",
        "Asia/Riyadh",
        "Asia/Sakhalin",
        "Asia/Samarkand",
        "Asia/Seoul",
        "Asia/Shanghai",
        "Asia/Singapore",
        "Asia/Srednekolymsk",
        "Asia/Taipei",
        "Asia/Tashkent",
        "Asia/Tbilisi",
        "Asia/Tehran",
        "Asia/Thimphu",
        "Asia/Tokyo",
        "Asia/Tomsk",
        "Asia/Ulaanbaatar",
        "Asia/Urumqi",
        "Asia/Ust-Nera",
        "Asia/Vladivostok",
        "Asia/Yakutsk",
        "Asia/Yangon",
        "Asia/Yekaterinburg",
        "Asia/Yerevan",
        "Atlantic/Azores",
        "Atlantic/Bermuda",
        "Atlantic/Canary",
        "Atlantic/Cape_Verde",
        "Atlantic/Faroe",
        "Atlantic/Madeira",
        "Atlantic/Reykjavik",
        "Atlantic/South_Georgia",
        "Atlantic/Stanley",
        "Australia/Adelaide",
        "Australia/Brisbane",
        "Australia/Broken_Hill",
        "Australia/Currie",
        "Australia/Darwin",
        "Australia/Eucla",
        "Australia/Hobart",
        "Australia/Lindeman",
        "Australia/Lord_Howe",
        "Australia/Melbourne",
        "Australia/Perth",
        "Australia/Sydney",
        "CET",
        "CST6CDT",
        "EET",
        "EST",
        "EST5EDT",
        "Etc/GMT",
        "Etc/GMT+1",
        "Etc/GMT+10",
        "Etc/GMT+11",
        "Etc/GMT+12",
        "Etc/GMT+2",
        "Etc/GMT+3",
        "Etc/GMT+4",
        "Etc/GMT+5",
        "Etc/GMT+6",
        "Etc/GMT+7",
        "Etc/GMT+8",
        "Etc/GMT+9",
        "Etc/GMT-1",
        "Etc/GMT-10",
        "Etc/GMT-11",
        "Etc/GMT-12",
        "Etc/GMT-13",
        "Etc/GMT-14",
        "Etc/GMT-2",
        "Etc/GMT-3",
        "Etc/GMT-4",
        "Etc/GMT-5",
        "Etc/GMT-6",
        "Etc/GMT-7",
        "Etc/GMT-8",
        "Etc/GMT-9",
        "Etc/UTC",
        "Europe/Amsterdam",
        "Europe/Andorra",
        "Europe/Astrakhan",
        "Europe/Athens",
        "Europe/Belgrade",
        "Europe/Berlin",
        "Europe/Brussels",
        "Europe/Bucharest",
        "Europe/Budapest",
        "Europe/Chisinau",
        "Europe/Copenhagen",
        "Europe/Dublin",
        "Europe/Gibraltar",
        "Europe/Helsinki",
        "Europe/Istanbul",
        "Europe/Kaliningrad",
        "Europe/Kiev",
        "Europe/Kirov",
        "Europe/Lisbon",
        "Europe/London",
        "Europe/Luxembourg",
        "Europe/Madrid",
        "Europe/Malta",
        "Europe/Minsk",
        "Europe/Monaco",
        "Europe/Moscow",
        "Europe/Oslo",
        "Europe/Paris",
        "Europe/Prague",
        "Europe/Riga",
        "Europe/Rome",
        "Europe/Samara",
        "Europe/Saratov",
        "Europe/Simferopol",
        "Europe/Sofia",
        "Europe/Stockholm",
        "Europe/Tallinn",
        "Europe/Tirane",
        "Europe/Ulyanovsk",
        "Europe/Uzhgorod",
        "Europe/Vienna",
        "Europe/Vilnius",
        "Europe/Volgograd",
        "Europe/Warsaw",
        "Europe/Zaporozhye",
        "Europe/Zurich",
        "Factory",
        "HST",
        "Indian/Chagos",
        "Indian/Christmas",
        "Indian/Cocos",
        "Indian/Kerguelen",
        "Indian/Mahe",
        "Indian/Maldives",
        "Indian/Mauritius",
        "Indian/Reunion",
        "MET",
        "MST",
        "MST7MDT",
        "PST8PDT",
        "Pacific/Apia",
        "Pacific/Auckland",
        "Pacific/Bougainville",
        "Pacific/Chatham",
        "Pacific/Chuuk",
        "Pacific/Easter",
        "Pacific/Efate",
        "Pacific/Enderbury",
        "Pacific/Fakaofo",
        "Pacific/Fiji",
        "Pacific/Funafuti",
        "Pacific/Galapagos",
        "Pacific/Gambier",
        "Pacific/Guadalcanal",
        "Pacific/Guam",
        "Pacific/Honolulu",
        "Pacific/Kiritimati",
        "Pacific/Kosrae",
        "Pacific/Kwajalein",
        "Pacific/Majuro",
        "Pacific/Marquesas",
        "Pacific/Nauru",
        "Pacific/Niue",
        "Pacific/Norfolk",
        "Pacific/Noumea",
        "Pacific/Pago_Pago",
        "Pacific/Palau",
        "Pacific/Pitcairn",
        "Pacific/Pohnpei",
        "Pacific/Port_Moresby",
        "Pacific/Rarotonga",
        "Pacific/Tahiti",
        "Pacific/Tarawa",
        "Pacific/Tongatapu",
        "Pacific/Wake",
        "Pacific/Wallis",
        "WET"
      ],
      "description": "User timezone"
    },
    "facebook_profile_url": {
      "type": "string",
      "description": "User facebook profile URL"
    },
    "instagram_profile_url": {
      "type": "string",
      "description": "User instagram profile URL"
    },
    "honorary_title": {
      "type": "string",
      "enum": [
        "mr",
        "mrs",
        "ms",
        "dr",
        "prof"
      ],
      "description": "User's honorary title"
    },
    "live_location": {
      "description": "User's current location. READ only, can't be updated",
      "type": "object",
      "properties": {
        "address": {
          "type": "string",
          "description": "Address"
        },
        "lat": {
          "type": "number",
          "format": "float",
          "description": "Latitude"
        },
        "lng": {
          "type": "number",
          "format": "float",
          "description": "Longitude"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "State"
        },
        "country_code": {
          "type": "string",
          "description": "Zip code"
        }
      }
    },
    "resume": {
      "type": "string",
      "description": "URL link to the user's resume"
    },
    "locale": {
      "type": "string",
      "enum": [
        "en",
        "en-GB",
        "fr",
        "he",
        "de",
        "es",
        "it",
        "da",
        "nl",
        "pt",
        "ru",
        "deepbloo",
        "zh-Hans",
        "zh-Hant",
        "af",
        "pl",
        "fi",
        "nl-BE",
        "nb"
      ],
      "description": "User Locale"
    },
    "share_email": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding email"
    },
    "share_email2": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding secondary email"
    },
    "share_email3": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding complementary email"
    },
    "share_postal_address_personal": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding postal home location"
    },
    "share_postal_address_work": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding postal work location"
    },
    "share_nationalities": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding nationalities"
    },
    "share_resume": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding resume"
    },
    "share_mobile_pro": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding work mobile phone"
    },
    "share_mobile_perso": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding personal mobile phone"
    },
    "share_landline_pro": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding professional landline phone"
    },
    "share_landline_perso": {
      "type": "string",
      "enum": [
        "with_admin",
        "with_all",
        "with_bookmarked_users"
      ],
      "description": "User's visibility information regarding personal landline phone"
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Array of customizable attributes with name, value and type"
    }
  },
  "description": "User model"
}

Get user profile
GET/api/admin/v1/users/{id}{?key}

Return the user profile based on it’s ID

Find the user matching this ID, or use external_id or previous_id as the key parameter to fetch the user on one of these identifier instead of default ID.

URI Parameters
id
string (required) 
key
string (required) 

PUT /api/admin/v1/users/_bulk
Requests
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "enum": [
        "external_id",
        "previous_id"
      ]
    },
    "users": {
      "type": "array",
      "description": "Array of Users",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "User ID"
          },
          "postal_personal": {
            "type": "object",
            "properties": {
              "address_1": {
                "type": "string",
                "description": "Address line 1"
              },
              "address_2": {
                "type": "string",
                "description": "Address line 2"
              },
              "address_3": {
                "type": "string",
                "description": "Address line 3"
              },
              "city": {
                "type": "string",
                "description": "City"
              },
              "state": {
                "type": "string",
                "description": "State"
              },
              "postal_code": {
                "type": "string",
                "description": "Zip code"
              },
              "country": {
                "type": "string",
                "description": "Country",
                "enum": [
                  "TJ",
                  "JM",
                  "HT",
                  "ST",
                  "MS",
                  "AE",
                  "PK",
                  "NL",
                  "LU",
                  "BZ",
                  "IR",
                  "BO",
                  "UY",
                  "GH",
                  "SA",
                  "CI",
                  "MF",
                  "TF",
                  "AI",
                  "QA",
                  "SX",
                  "LY",
                  "BV",
                  "PG",
                  "KG",
                  "GQ",
                  "EH",
                  "NU",
                  "PR",
                  "GD",
                  "KR",
                  "HM",
                  "SM",
                  "SL",
                  "CD",
                  "MK",
                  "TR",
                  "DZ",
                  "GE",
                  "PS",
                  "BB",
                  "UA",
                  "GP",
                  "PF",
                  "NA",
                  "BW",
                  "SY",
                  "TG",
                  "DO",
                  "AQ",
                  "CH",
                  "MG",
                  "FO",
                  "VG",
                  "GI",
                  "BN",
                  "LA",
                  "IS",
                  "EE",
                  "UM",
                  "LT",
                  "RS",
                  "MR",
                  "AD",
                  "HU",
                  "TK",
                  "MY",
                  "AO",
                  "CV",
                  "NF",
                  "PA",
                  "GW",
                  "BE",
                  "PT",
                  "GB",
                  "IM",
                  "US",
                  "YE",
                  "HK",
                  "AZ",
                  "CC",
                  "ML",
                  "SK",
                  "VU",
                  "TL",
                  "HR",
                  "SR",
                  "MU",
                  "CZ",
                  "PM",
                  "LS",
                  "WS",
                  "KM",
                  "IT",
                  "BI",
                  "WF",
                  "GN",
                  "SG",
                  "CO",
                  "CN",
                  "AW",
                  "MA",
                  "FI",
                  "VA",
                  "ZW",
                  "KY",
                  "BH",
                  "PY",
                  "EC",
                  "LR",
                  "RU",
                  "PL",
                  "OM",
                  "MT",
                  "SS",
                  "DE",
                  "TM",
                  "SJ",
                  "MM",
                  "TT",
                  "IL",
                  "BD",
                  "NR",
                  "LK",
                  "UG",
                  "NG",
                  "BQ",
                  "MX",
                  "CW",
                  "SI",
                  "MN",
                  "CA",
                  "AX",
                  "VN",
                  "TW",
                  "JP",
                  "IO",
                  "RO",
                  "BG",
                  "GU",
                  "BR",
                  "AM",
                  "ZM",
                  "DJ",
                  "JE",
                  "AT",
                  "CM",
                  "SE",
                  "FJ",
                  "KZ",
                  "GL",
                  "GY",
                  "CX",
                  "MW",
                  "TN",
                  "ZA",
                  "TO",
                  "CY",
                  "MV",
                  "PN",
                  "RW",
                  "NI",
                  "KN",
                  "BJ",
                  "ET",
                  "GM",
                  "TZ",
                  "VC",
                  "FK",
                  "SD",
                  "MC",
                  "AU",
                  "CL",
                  "DK",
                  "FR",
                  "TC",
                  "CU",
                  "AL",
                  "MZ",
                  "BS",
                  "NE",
                  "GT",
                  "LI",
                  "NP",
                  "BF",
                  "PW",
                  "KW",
                  "IN",
                  "GA",
                  "TV",
                  "MO",
                  "SH",
                  "MD",
                  "CK",
                  "AR",
                  "SC",
                  "IE",
                  "ES",
                  "LB",
                  "BM",
                  "RE",
                  "KI",
                  "AG",
                  "MQ",
                  "SV",
                  "JO",
                  "TH",
                  "SO",
                  "MH",
                  "CG",
                  "KP",
                  "GF",
                  "BA",
                  "YT",
                  "GS",
                  "KE",
                  "PE",
                  "BT",
                  "SZ",
                  "CR",
                  "TD",
                  "DM",
                  "NC",
                  "GR",
                  "GG",
                  "HN",
                  "VI",
                  "CF",
                  "SN",
                  "AF",
                  "MP",
                  "PH",
                  "BY",
                  "LV",
                  "NO",
                  "EG",
                  "KH",
                  "IQ",
                  "LC",
                  "NZ",
                  "BL",
                  "UZ",
                  "ID",
                  "ER",
                  "VE",
                  "FM",
                  "SB",
                  "ME",
                  "AS",
                  "XK"
                ]
              },
              "default_billing_address": {
                "type": "boolean",
                "description": "is the default billing address for the user ?"
              },
              "created_at": {
                "type": "string",
                "format": "date-time",
                "description": "Postal address creation date time - iso8601"
              },
              "updated_at": {
                "type": "string",
                "format": "date-time",
                "description": "Postal address last update date time - iso8601"
              }
            }
          },
          "postal_work": {
            "description": "User work postal address",
            "type": "object",
            "properties": {
              "address_1": {
                "type": "string",
                "description": "Address line 1"
              },
              "address_2": {
                "type": "string",
                "description": "Address line 2"
              },
              "address_3": {
                "type": "string",
                "description": "Address line 3"
              },
              "city": {
                "type": "string",
                "description": "City"
              },
              "state": {
                "type": "string",
                "description": "State"
              },
              "postal_code": {
                "type": "string",
                "description": "Zip code"
              },
              "country": {
                "type": "string",
                "description": "Country",
                "enum": [
                  "TJ",
                  "JM",
                  "HT",
                  "ST",
                  "MS",
                  "AE",
                  "PK",
                  "NL",
                  "LU",
                  "BZ",
                  "IR",
                  "BO",
                  "UY",
                  "GH",
                  "SA",
                  "CI",
                  "MF",
                  "TF",
                  "AI",
                  "QA",
                  "SX",
                  "LY",
                  "BV",
                  "PG",
                  "KG",
                  "GQ",
                  "EH",
                  "NU",
                  "PR",
                  "GD",
                  "KR",
                  "HM",
                  "SM",
                  "SL",
                  "CD",
                  "MK",
                  "TR",
                  "DZ",
                  "GE",
                  "PS",
                  "BB",
                  "UA",
                  "GP",
                  "PF",
                  "NA",
                  "BW",
                  "SY",
                  "TG",
                  "DO",
                  "AQ",
                  "CH",
                  "MG",
                  "FO",
                  "VG",
                  "GI",
                  "BN",
                  "LA",
                  "IS",
                  "EE",
                  "UM",
                  "LT",
                  "RS",
                  "MR",
                  "AD",
                  "HU",
                  "TK",
                  "MY",
                  "AO",
                  "CV",
                  "NF",
                  "PA",
                  "GW",
                  "BE",
                  "PT",
                  "GB",
                  "IM",
                  "US",
                  "YE",
                  "HK",
                  "AZ",
                  "CC",
                  "ML",
                  "SK",
                  "VU",
                  "TL",
                  "HR",
                  "SR",
                  "MU",
                  "CZ",
                  "PM",
                  "LS",
                  "WS",
                  "KM",
                  "IT",
                  "BI",
                  "WF",
                  "GN",
                  "SG",
                  "CO",
                  "CN",
                  "AW",
                  "MA",
                  "FI",
                  "VA",
                  "ZW",
                  "KY",
                  "BH",
                  "PY",
                  "EC",
                  "LR",
                  "RU",
                  "PL",
                  "OM",
                  "MT",
                  "SS",
                  "DE",
                  "TM",
                  "SJ",
                  "MM",
                  "TT",
                  "IL",
                  "BD",
                  "NR",
                  "LK",
                  "UG",
                  "NG",
                  "BQ",
                  "MX",
                  "CW",
                  "SI",
                  "MN",
                  "CA",
                  "AX",
                  "VN",
                  "TW",
                  "JP",
                  "IO",
                  "RO",
                  "BG",
                  "GU",
                  "BR",
                  "AM",
                  "ZM",
                  "DJ",
                  "JE",
                  "AT",
                  "CM",
                  "SE",
                  "FJ",
                  "KZ",
                  "GL",
                  "GY",
                  "CX",
                  "MW",
                  "TN",
                  "ZA",
                  "TO",
                  "CY",
                  "MV",
                  "PN",
                  "RW",
                  "NI",
                  "KN",
                  "BJ",
                  "ET",
                  "GM",
                  "TZ",
                  "VC",
                  "FK",
                  "SD",
                  "MC",
                  "AU",
                  "CL",
                  "DK",
                  "FR",
                  "TC",
                  "CU",
                  "AL",
                  "MZ",
                  "BS",
                  "NE",
                  "GT",
                  "LI",
                  "NP",
                  "BF",
                  "PW",
                  "KW",
                  "IN",
                  "GA",
                  "TV",
                  "MO",
                  "SH",
                  "MD",
                  "CK",
                  "AR",
                  "SC",
                  "IE",
                  "ES",
                  "LB",
                  "BM",
                  "RE",
                  "KI",
                  "AG",
                  "MQ",
                  "SV",
                  "JO",
                  "TH",
                  "SO",
                  "MH",
                  "CG",
                  "KP",
                  "GF",
                  "BA",
                  "YT",
                  "GS",
                  "KE",
                  "PE",
                  "BT",
                  "SZ",
                  "CR",
                  "TD",
                  "DM",
                  "NC",
                  "GR",
                  "GG",
                  "HN",
                  "VI",
                  "CF",
                  "SN",
                  "AF",
                  "MP",
                  "PH",
                  "BY",
                  "LV",
                  "NO",
                  "EG",
                  "KH",
                  "IQ",
                  "LC",
                  "NZ",
                  "BL",
                  "UZ",
                  "ID",
                  "ER",
                  "VE",
                  "FM",
                  "SB",
                  "ME",
                  "AS",
                  "XK"
                ]
              },
              "default_billing_address": {
                "type": "boolean",
                "description": "is the default billing address for the user ?"
              },
              "created_at": {
                "type": "string",
                "format": "date-time",
                "description": "Postal address creation date time - iso8601"
              },
              "updated_at": {
                "type": "string",
                "format": "date-time",
                "description": "Postal address last update date time - iso8601"
              }
            }
          },
          "config": {
            "type": "object",
            "properties": {
              "private_profile": {
                "type": "boolean",
                "description": "Unique ID"
              },
              "opt_out_of_directory": {
                "type": "boolean",
                "description": "Unique ID"
              },
              "share_gender": {
                "type": "string",
                "description": "Privacy sharing status of gender",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_prefix_firstname": {
                "type": "string",
                "description": "Privacy sharing status of prefix_firstname",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_honorary_title": {
                "type": "string",
                "description": "Privacy sharing status of honorary_title",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_prefix_name": {
                "type": "string",
                "description": "Privacy sharing status of prefix_name",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_suffix_name": {
                "type": "string",
                "description": "Privacy sharing status of suffix_name",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_maidenname": {
                "type": "string",
                "description": "Privacy sharing status of maidenname",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_birthday": {
                "type": "string",
                "description": "Privacy sharing status of birthday",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_birthplace": {
                "type": "string",
                "description": "Privacy sharing status of birthplace",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_headline": {
                "type": "string",
                "description": "Privacy sharing status of headline",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_nationalities": {
                "type": "string",
                "description": "Privacy sharing status of nationalities",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_live_location": {
                "type": "string",
                "description": "Privacy sharing status of live_location",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_sub_networks": {
                "type": "string",
                "description": "Privacy sharing status of sub_networks",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_resume": {
                "type": "string",
                "description": "Privacy sharing status of resume",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_summary": {
                "type": "string",
                "description": "Privacy sharing status of summary",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_industries": {
                "type": "string",
                "description": "Privacy sharing status of industries",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_skills": {
                "type": "string",
                "description": "Privacy sharing status of skills",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_facebook_profile_url": {
                "type": "string",
                "description": "Privacy sharing status of facebook_profile_url",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_instagram_profile_url": {
                "type": "string",
                "description": "Privacy sharing status of instagram_profile_url",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_twitter": {
                "type": "string",
                "description": "Privacy sharing status of twitter",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_skype": {
                "type": "string",
                "description": "Privacy sharing status of skype",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_linkedin_profile_url": {
                "type": "string",
                "description": "Privacy sharing status of linkedin_profile_url",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_website": {
                "type": "string",
                "description": "Privacy sharing status of website",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_bbm": {
                "type": "string",
                "description": "Privacy sharing status of bbm",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_email": {
                "type": "string",
                "description": "Privacy sharing status of email",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_email2": {
                "type": "string",
                "description": "Privacy sharing status of email2",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_email3": {
                "type": "string",
                "description": "Privacy sharing status of email3",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_mobile_perso": {
                "type": "string",
                "description": "Privacy sharing status of mobile_perso",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_landline_perso": {
                "type": "string",
                "description": "Privacy sharing status of landline_perso",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_mobile_pro": {
                "type": "string",
                "description": "Privacy sharing status of mobile_pro",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_landline_pro": {
                "type": "string",
                "description": "Privacy sharing status of landline_pro",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_postal_personal": {
                "type": "string",
                "description": "Privacy sharing status of postal_personal",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_postal_work": {
                "type": "string",
                "description": "Privacy sharing status of postal_work",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_memberships": {
                "type": "string",
                "description": "Privacy sharing status of memberships",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_educations": {
                "type": "string",
                "description": "Privacy sharing status of educations",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              },
              "share_experiences": {
                "type": "string",
                "description": "Privacy sharing status of experiences",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ]
              }
            }
          },
          "email": {
            "type": "string",
            "description": "User email"
          },
          "sub_network_ids": {
            "type": "array",
            "description": "IDs list of user sub networks",
            "items": {
              "type": "integer",
              "format": "int32"
            }
          },
          "extended_updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
          },
          "email2": {
            "type": "string",
            "description": "User secondary email"
          },
          "email3": {
            "type": "string",
            "description": "User complementary email"
          },
          "primary_email_choice": {
            "type": "string",
            "description": "User primary email choice",
            "enum": [
              "email",
              "email2",
              "email3"
            ]
          },
          "firstname": {
            "type": "string",
            "description": "User first name"
          },
          "lastname": {
            "type": "string",
            "description": "User last name"
          },
          "maidenname": {
            "type": "string",
            "description": "User maiden name"
          },
          "prefix_firstname": {
            "type": "string",
            "description": "User prefix firstname"
          },
          "prefix_name": {
            "type": "string",
            "description": "User prefix name"
          },
          "suffix_name": {
            "type": "string",
            "description": "User suffix name"
          },
          "external_id": {
            "type": "string",
            "description": "User ID in your database"
          },
          "sso_identifier": {
            "type": "string",
            "description": "User identifier for SSO"
          },
          "previous_id": {
            "type": "string",
            "description": "User ID in your community system"
          },
          "is_active": {
            "type": "boolean",
            "description": "User account enabled ?"
          },
          "gender": {
            "type": "string",
            "description": "User gender (male/female/other)",
            "enum": [
              "male",
              "female",
              "other"
            ]
          },
          "birthday": {
            "type": "string",
            "format": "date",
            "description": "User birth date"
          },
          "birthplace": {
            "type": "string",
            "description": "User birth place"
          },
          "headline": {
            "type": "string",
            "description": "User headline"
          },
          "summary": {
            "type": "string",
            "description": "User summary"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "User creation date time - iso8601. READ only, can't be updated"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "User last update date time - iso8601. READ only, can't be updated"
          },
          "citizenship_ids": {
            "type": "array",
            "description": "List of citizenship IDs",
            "items": {
              "type": "integer",
              "format": "int32"
            }
          },
          "citizenship_country_codes": {
            "type": "array",
            "description": "List of ISO-3166-2 citizenship country codes",
            "items": {
              "type": "string"
            }
          },
          "deceased": {
            "type": "boolean",
            "description": "User deceased ?"
          },
          "deceased_at": {
            "type": "string",
            "format": "date-time",
            "description": "User decease date time - iso8601."
          },
          "do_not_contact": {
            "type": "boolean",
            "description": "User can be contacted ?"
          },
          "mobile_perso": {
            "type": "string",
            "description": "User mobile perso number"
          },
          "mobile_pro": {
            "type": "string",
            "description": "User mobile pro number"
          },
          "landline_perso": {
            "type": "string",
            "description": "User landline perso number"
          },
          "landline_pro": {
            "type": "string",
            "description": "User landline pro number"
          },
          "preferred_phone_number": {
            "type": "string",
            "description": "User preferred phone number",
            "enum": [
              "mobile_pro",
              "mobile_perso",
              "landline_pro",
              "landline_perso",
              "none"
            ]
          },
          "preferred_postal_address": {
            "type": "string",
            "description": "User preferred postal address",
            "enum": [
              "postal_personal",
              "postal_work"
            ]
          },
          "role_id": {
            "type": "integer",
            "format": "int32",
            "description": "User role ID"
          },
          "awards": {
            "type": "string",
            "description": "User awards"
          },
          "linkedin_profile_url": {
            "type": "string",
            "description": "User linkedin profile URL"
          },
          "website": {
            "type": "string",
            "description": "User Website URL"
          },
          "skype": {
            "type": "string",
            "description": "User skype profile"
          },
          "bbm": {
            "type": "string",
            "description": "User BlackBerry Messenger profile"
          },
          "twitter": {
            "type": "string",
            "description": "User twitter profile"
          },
          "timezone": {
            "type": "string",
            "description": "User timezone",
            "enum": [
              "Africa/Abidjan",
              "Africa/Accra",
              "Africa/Algiers",
              "Africa/Bissau",
              "Africa/Cairo",
              "Africa/Casablanca",
              "Africa/Ceuta",
              "Africa/El_Aaiun",
              "Africa/Johannesburg",
              "Africa/Juba",
              "Africa/Khartoum",
              "Africa/Lagos",
              "Africa/Maputo",
              "Africa/Monrovia",
              "Africa/Nairobi",
              "Africa/Ndjamena",
              "Africa/Sao_Tome",
              "Africa/Tripoli",
              "Africa/Tunis",
              "Africa/Windhoek",
              "America/Adak",
              "America/Anchorage",
              "America/Araguaina",
              "America/Argentina/Buenos_Aires",
              "America/Argentina/Catamarca",
              "America/Argentina/Cordoba",
              "America/Argentina/Jujuy",
              "America/Argentina/La_Rioja",
              "America/Argentina/Mendoza",
              "America/Argentina/Rio_Gallegos",
              "America/Argentina/Salta",
              "America/Argentina/San_Juan",
              "America/Argentina/San_Luis",
              "America/Argentina/Tucuman",
              "America/Argentina/Ushuaia",
              "America/Asuncion",
              "America/Atikokan",
              "America/Bahia",
              "America/Bahia_Banderas",
              "America/Barbados",
              "America/Belem",
              "America/Belize",
              "America/Blanc-Sablon",
              "America/Boa_Vista",
              "America/Bogota",
              "America/Boise",
              "America/Cambridge_Bay",
              "America/Campo_Grande",
              "America/Cancun",
              "America/Caracas",
              "America/Cayenne",
              "America/Chicago",
              "America/Chihuahua",
              "America/Costa_Rica",
              "America/Creston",
              "America/Cuiaba",
              "America/Curacao",
              "America/Danmarkshavn",
              "America/Dawson",
              "America/Dawson_Creek",
              "America/Denver",
              "America/Detroit",
              "America/Edmonton",
              "America/Eirunepe",
              "America/El_Salvador",
              "America/Fort_Nelson",
              "America/Fortaleza",
              "America/Glace_Bay",
              "America/Goose_Bay",
              "America/Grand_Turk",
              "America/Guatemala",
              "America/Guayaquil",
              "America/Guyana",
              "America/Halifax",
              "America/Havana",
              "America/Hermosillo",
              "America/Indiana/Indianapolis",
              "America/Indiana/Knox",
              "America/Indiana/Marengo",
              "America/Indiana/Petersburg",
              "America/Indiana/Tell_City",
              "America/Indiana/Vevay",
              "America/Indiana/Vincennes",
              "America/Indiana/Winamac",
              "America/Inuvik",
              "America/Iqaluit",
              "America/Jamaica",
              "America/Juneau",
              "America/Kentucky/Louisville",
              "America/Kentucky/Monticello",
              "America/La_Paz",
              "America/Lima",
              "America/Los_Angeles",
              "America/Maceio",
              "America/Managua",
              "America/Manaus",
              "America/Martinique",
              "America/Matamoros",
              "America/Mazatlan",
              "America/Menominee",
              "America/Merida",
              "America/Metlakatla",
              "America/Mexico_City",
              "America/Miquelon",
              "America/Moncton",
              "America/Monterrey",
              "America/Montevideo",
              "America/Nassau",
              "America/New_York",
              "America/Nipigon",
              "America/Nome",
              "America/Noronha",
              "America/North_Dakota/Beulah",
              "America/North_Dakota/Center",
              "America/North_Dakota/New_Salem",
              "America/Nuuk",
              "America/Ojinaga",
              "America/Panama",
              "America/Pangnirtung",
              "America/Paramaribo",
              "America/Phoenix",
              "America/Port-au-Prince",
              "America/Port_of_Spain",
              "America/Porto_Velho",
              "America/Puerto_Rico",
              "America/Punta_Arenas",
              "America/Rainy_River",
              "America/Rankin_Inlet",
              "America/Recife",
              "America/Regina",
              "America/Resolute",
              "America/Rio_Branco",
              "America/Santarem",
              "America/Santiago",
              "America/Santo_Domingo",
              "America/Sao_Paulo",
              "America/Scoresbysund",
              "America/Sitka",
              "America/St_Johns",
              "America/Swift_Current",
              "America/Tegucigalpa",
              "America/Thule",
              "America/Thunder_Bay",
              "America/Tijuana",
              "America/Toronto",
              "America/Vancouver",
              "America/Whitehorse",
              "America/Winnipeg",
              "America/Yakutat",
              "America/Yellowknife",
              "Antarctica/Casey",
              "Antarctica/Davis",
              "Antarctica/DumontDUrville",
              "Antarctica/Macquarie",
              "Antarctica/Mawson",
              "Antarctica/Palmer",
              "Antarctica/Rothera",
              "Antarctica/Syowa",
              "Antarctica/Troll",
              "Antarctica/Vostok",
              "Asia/Almaty",
              "Asia/Amman",
              "Asia/Anadyr",
              "Asia/Aqtau",
              "Asia/Aqtobe",
              "Asia/Ashgabat",
              "Asia/Atyrau",
              "Asia/Baghdad",
              "Asia/Baku",
              "Asia/Bangkok",
              "Asia/Barnaul",
              "Asia/Beirut",
              "Asia/Bishkek",
              "Asia/Brunei",
              "Asia/Chita",
              "Asia/Choibalsan",
              "Asia/Colombo",
              "Asia/Damascus",
              "Asia/Dhaka",
              "Asia/Dili",
              "Asia/Dubai",
              "Asia/Dushanbe",
              "Asia/Famagusta",
              "Asia/Gaza",
              "Asia/Hebron",
              "Asia/Ho_Chi_Minh",
              "Asia/Hong_Kong",
              "Asia/Hovd",
              "Asia/Irkutsk",
              "Asia/Jakarta",
              "Asia/Jayapura",
              "Asia/Jerusalem",
              "Asia/Kabul",
              "Asia/Kamchatka",
              "Asia/Karachi",
              "Asia/Kathmandu",
              "Asia/Khandyga",
              "Asia/Kolkata",
              "Asia/Krasnoyarsk",
              "Asia/Kuala_Lumpur",
              "Asia/Kuching",
              "Asia/Macau",
              "Asia/Magadan",
              "Asia/Makassar",
              "Asia/Manila",
              "Asia/Nicosia",
              "Asia/Novokuznetsk",
              "Asia/Novosibirsk",
              "Asia/Omsk",
              "Asia/Oral",
              "Asia/Pontianak",
              "Asia/Pyongyang",
              "Asia/Qatar",
              "Asia/Qostanay",
              "Asia/Qyzylorda",
              "Asia/Riyadh",
              "Asia/Sakhalin",
              "Asia/Samarkand",
              "Asia/Seoul",
              "Asia/Shanghai",
              "Asia/Singapore",
              "Asia/Srednekolymsk",
              "Asia/Taipei",
              "Asia/Tashkent",
              "Asia/Tbilisi",
              "Asia/Tehran",
              "Asia/Thimphu",
              "Asia/Tokyo",
              "Asia/Tomsk",
              "Asia/Ulaanbaatar",
              "Asia/Urumqi",
              "Asia/Ust-Nera",
              "Asia/Vladivostok",
              "Asia/Yakutsk",
              "Asia/Yangon",
              "Asia/Yekaterinburg",
              "Asia/Yerevan",
              "Atlantic/Azores",
              "Atlantic/Bermuda",
              "Atlantic/Canary",
              "Atlantic/Cape_Verde",
              "Atlantic/Faroe",
              "Atlantic/Madeira",
              "Atlantic/Reykjavik",
              "Atlantic/South_Georgia",
              "Atlantic/Stanley",
              "Australia/Adelaide",
              "Australia/Brisbane",
              "Australia/Broken_Hill",
              "Australia/Currie",
              "Australia/Darwin",
              "Australia/Eucla",
              "Australia/Hobart",
              "Australia/Lindeman",
              "Australia/Lord_Howe",
              "Australia/Melbourne",
              "Australia/Perth",
              "Australia/Sydney",
              "CET",
              "CST6CDT",
              "EET",
              "EST",
              "EST5EDT",
              "Etc/GMT",
              "Etc/GMT+1",
              "Etc/GMT+10",
              "Etc/GMT+11",
              "Etc/GMT+12",
              "Etc/GMT+2",
              "Etc/GMT+3",
              "Etc/GMT+4",
              "Etc/GMT+5",
              "Etc/GMT+6",
              "Etc/GMT+7",
              "Etc/GMT+8",
              "Etc/GMT+9",
              "Etc/GMT-1",
              "Etc/GMT-10",
              "Etc/GMT-11",
              "Etc/GMT-12",
              "Etc/GMT-13",
              "Etc/GMT-14",
              "Etc/GMT-2",
              "Etc/GMT-3",
              "Etc/GMT-4",
              "Etc/GMT-5",
              "Etc/GMT-6",
              "Etc/GMT-7",
              "Etc/GMT-8",
              "Etc/GMT-9",
              "Etc/UTC",
              "Europe/Amsterdam",
              "Europe/Andorra",
              "Europe/Astrakhan",
              "Europe/Athens",
              "Europe/Belgrade",
              "Europe/Berlin",
              "Europe/Brussels",
              "Europe/Bucharest",
              "Europe/Budapest",
              "Europe/Chisinau",
              "Europe/Copenhagen",
              "Europe/Dublin",
              "Europe/Gibraltar",
              "Europe/Helsinki",
              "Europe/Istanbul",
              "Europe/Kaliningrad",
              "Europe/Kiev",
              "Europe/Kirov",
              "Europe/Lisbon",
              "Europe/London",
              "Europe/Luxembourg",
              "Europe/Madrid",
              "Europe/Malta",
              "Europe/Minsk",
              "Europe/Monaco",
              "Europe/Moscow",
              "Europe/Oslo",
              "Europe/Paris",
              "Europe/Prague",
              "Europe/Riga",
              "Europe/Rome",
              "Europe/Samara",
              "Europe/Saratov",
              "Europe/Simferopol",
              "Europe/Sofia",
              "Europe/Stockholm",
              "Europe/Tallinn",
              "Europe/Tirane",
              "Europe/Ulyanovsk",
              "Europe/Uzhgorod",
              "Europe/Vienna",
              "Europe/Vilnius",
              "Europe/Volgograd",
              "Europe/Warsaw",
              "Europe/Zaporozhye",
              "Europe/Zurich",
              "Factory",
              "HST",
              "Indian/Chagos",
              "Indian/Christmas",
              "Indian/Cocos",
              "Indian/Kerguelen",
              "Indian/Mahe",
              "Indian/Maldives",
              "Indian/Mauritius",
              "Indian/Reunion",
              "MET",
              "MST",
              "MST7MDT",
              "PST8PDT",
              "Pacific/Apia",
              "Pacific/Auckland",
              "Pacific/Bougainville",
              "Pacific/Chatham",
              "Pacific/Chuuk",
              "Pacific/Easter",
              "Pacific/Efate",
              "Pacific/Enderbury",
              "Pacific/Fakaofo",
              "Pacific/Fiji",
              "Pacific/Funafuti",
              "Pacific/Galapagos",
              "Pacific/Gambier",
              "Pacific/Guadalcanal",
              "Pacific/Guam",
              "Pacific/Honolulu",
              "Pacific/Kiritimati",
              "Pacific/Kosrae",
              "Pacific/Kwajalein",
              "Pacific/Majuro",
              "Pacific/Marquesas",
              "Pacific/Nauru",
              "Pacific/Niue",
              "Pacific/Norfolk",
              "Pacific/Noumea",
              "Pacific/Pago_Pago",
              "Pacific/Palau",
              "Pacific/Pitcairn",
              "Pacific/Pohnpei",
              "Pacific/Port_Moresby",
              "Pacific/Rarotonga",
              "Pacific/Tahiti",
              "Pacific/Tarawa",
              "Pacific/Tongatapu",
              "Pacific/Wake",
              "Pacific/Wallis",
              "WET"
            ]
          },
          "facebook_profile_url": {
            "type": "string",
            "description": "User facebook profile URL"
          },
          "instagram_profile_url": {
            "type": "string",
            "description": "User instagram profile URL"
          },
          "honorary_title": {
            "type": "string",
            "description": "User's honorary title",
            "enum": [
              "mr",
              "mrs",
              "ms",
              "dr",
              "prof"
            ]
          },
          "locale": {
            "type": "string",
            "description": "User Locale",
            "enum": [
              "en",
              "en-GB",
              "fr",
              "he",
              "de",
              "es",
              "it",
              "da",
              "nl",
              "pt",
              "ru",
              "deepbloo",
              "zh-Hans",
              "zh-Hant",
              "af",
              "pl",
              "fi",
              "nl-BE",
              "nb"
            ]
          },
          "share_email": {
            "type": "string",
            "description": "User's visibility information regarding email",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ]
          },
          "share_email2": {
            "type": "string",
            "description": "User's visibility information regarding secondary email",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ]
          },
          "share_email3": {
            "type": "string",
            "description": "User's visibility information regarding complementary email",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ]
          },
          "share_postal_address_personal": {
            "type": "string",
            "description": "User's visibility information regarding postal home location",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ]
          },
          "share_postal_address_work": {
            "type": "string",
            "description": "User's visibility information regarding postal work location",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ]
          },
          "share_nationalities": {
            "type": "string",
            "description": "User's visibility information regarding nationalities",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ]
          },
          "share_resume": {
            "type": "string",
            "description": "User's visibility information regarding resume",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ]
          },
          "share_mobile_pro": {
            "type": "string",
            "description": "User's visibility information regarding work mobile phone",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ]
          },
          "share_mobile_perso": {
            "type": "string",
            "description": "User's visibility information regarding personal mobile phone",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ]
          },
          "share_landline_pro": {
            "type": "string",
            "description": "User's visibility information regarding professional landline phone",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ]
          },
          "share_landline_perso": {
            "type": "string",
            "description": "User's visibility information regarding personal landline phone",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ]
          },
          "custom_attributes": {
            "type": "array",
            "description": "Array of customizable attributes with name, value and type",
            "items": {
              "type": "object"
            }
          },
          "photo": {
            "type": "file",
            "description": "Profile picture of the user"
          },
          "resume": {
            "type": "file",
            "description": "Resume of the user"
          }
        },
        "required": [
          "id"
        ]
      }
    }
  },
  "required": [
    "users"
  ],
  "description": "Bulk update of existing users"
}
Responses200422

Bulk update of existing users

Schema
{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique ID"
          },
          "email": {
            "type": "string",
            "description": "User email"
          },
          "name": {
            "type": "string",
            "description": "User full name"
          },
          "sub_network_ids": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            },
            "description": "IDs list of user sub networks"
          },
          "extended_updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
          },
          "email2": {
            "type": "string",
            "description": "User secondary email"
          },
          "email3": {
            "type": "string",
            "description": "User complementary email"
          },
          "primary_email_choice": {
            "type": "string",
            "enum": [
              "email",
              "email2",
              "email3"
            ],
            "description": "User primary email choice"
          },
          "firstname": {
            "type": "string",
            "description": "User first name"
          },
          "lastname": {
            "type": "string",
            "description": "User last name"
          },
          "maidenname": {
            "type": "string",
            "description": "User maiden name"
          },
          "prefix_firstname": {
            "type": "string",
            "description": "User prefix firstname"
          },
          "prefix_name": {
            "type": "string",
            "description": "User prefix name"
          },
          "suffix_name": {
            "type": "string",
            "description": "User suffix name"
          },
          "external_id": {
            "type": "string",
            "description": "User ID in your database"
          },
          "sso_identifier": {
            "type": "string",
            "description": "User identifier for SSO"
          },
          "previous_id": {
            "type": "string",
            "description": "User ID in your community system"
          },
          "is_active": {
            "type": "boolean",
            "description": "User account enabled ?"
          },
          "gender": {
            "type": "string",
            "enum": [
              "male",
              "female",
              "other"
            ],
            "description": "User gender (male/female/other)"
          },
          "birthday": {
            "type": "string",
            "format": "date",
            "description": "User birth date"
          },
          "birthplace": {
            "type": "string",
            "description": "User birth place"
          },
          "headline": {
            "type": "string",
            "description": "User headline"
          },
          "summary": {
            "type": "string",
            "description": "User summary"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "User creation date time - iso8601. READ only, can't be updated"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "User last update date time - iso8601. READ only, can't be updated"
          },
          "confirmed_at": {
            "type": "string",
            "format": "date-time",
            "description": "User activation date time - iso8601. READ only, can't be updated"
          },
          "citizenship_ids": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            },
            "description": "List of citizenship IDs"
          },
          "citizenship_country_codes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of ISO-3166-2 citizenship country codes"
          },
          "deceased": {
            "type": "boolean",
            "description": "User deceased ?"
          },
          "deceased_at": {
            "type": "string",
            "format": "date-time",
            "description": "User decease date time - iso8601."
          },
          "photo": {
            "type": "object",
            "properties": {
              "large-url": {
                "type": "string",
                "description": "User large photo url"
              },
              "medium-url": {
                "type": "string",
                "description": "User medium photo url"
              },
              "thumb-url": {
                "type": "string",
                "description": "User thumb photo url"
              },
              "mini-url": {
                "type": "string",
                "description": "User mini photo url"
              },
              "friend-url": {
                "type": "string",
                "description": "User friend photo url"
              },
              "icon-url": {
                "type": "string",
                "description": "User icon photo url"
              }
            },
            "description": "User photo urls"
          },
          "do_not_contact": {
            "type": "boolean",
            "description": "User can be contacted ?"
          },
          "mobile_perso": {
            "type": "string",
            "description": "User mobile perso number"
          },
          "mobile_pro": {
            "type": "string",
            "description": "User mobile pro number"
          },
          "landline_perso": {
            "type": "string",
            "description": "User landline perso number"
          },
          "landline_pro": {
            "type": "string",
            "description": "User landline pro number"
          },
          "preferred_phone_number": {
            "type": "string",
            "enum": [
              "mobile_pro",
              "mobile_perso",
              "landline_pro",
              "landline_perso",
              "none"
            ],
            "description": "User preferred phone number"
          },
          "postal_personal": {
            "description": "User personal postal address",
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "format": "int32",
                "description": "Unique ID"
              },
              "address_1": {
                "type": "string",
                "description": "Address line 1"
              },
              "address_2": {
                "type": "string",
                "description": "Address line 2"
              },
              "address_3": {
                "type": "string",
                "description": "Address line 3"
              },
              "city": {
                "type": "string",
                "description": "City"
              },
              "state": {
                "type": "string",
                "description": "State"
              },
              "postal_code": {
                "type": "string",
                "description": "Zip code"
              },
              "country": {
                "type": "string",
                "enum": [
                  "TJ",
                  "JM",
                  "HT",
                  "ST",
                  "MS",
                  "AE",
                  "PK",
                  "NL",
                  "LU",
                  "BZ",
                  "IR",
                  "BO",
                  "UY",
                  "GH",
                  "SA",
                  "CI",
                  "MF",
                  "TF",
                  "AI",
                  "QA",
                  "SX",
                  "LY",
                  "BV",
                  "PG",
                  "KG",
                  "GQ",
                  "EH",
                  "NU",
                  "PR",
                  "GD",
                  "KR",
                  "HM",
                  "SM",
                  "SL",
                  "CD",
                  "MK",
                  "TR",
                  "DZ",
                  "GE",
                  "PS",
                  "BB",
                  "UA",
                  "GP",
                  "PF",
                  "NA",
                  "BW",
                  "SY",
                  "TG",
                  "DO",
                  "AQ",
                  "CH",
                  "MG",
                  "FO",
                  "VG",
                  "GI",
                  "BN",
                  "LA",
                  "IS",
                  "EE",
                  "UM",
                  "LT",
                  "RS",
                  "MR",
                  "AD",
                  "HU",
                  "TK",
                  "MY",
                  "AO",
                  "CV",
                  "NF",
                  "PA",
                  "GW",
                  "BE",
                  "PT",
                  "GB",
                  "IM",
                  "US",
                  "YE",
                  "HK",
                  "AZ",
                  "CC",
                  "ML",
                  "SK",
                  "VU",
                  "TL",
                  "HR",
                  "SR",
                  "MU",
                  "CZ",
                  "PM",
                  "LS",
                  "WS",
                  "KM",
                  "IT",
                  "BI",
                  "WF",
                  "GN",
                  "SG",
                  "CO",
                  "CN",
                  "AW",
                  "MA",
                  "FI",
                  "VA",
                  "ZW",
                  "KY",
                  "BH",
                  "PY",
                  "EC",
                  "LR",
                  "RU",
                  "PL",
                  "OM",
                  "MT",
                  "SS",
                  "DE",
                  "TM",
                  "SJ",
                  "MM",
                  "TT",
                  "IL",
                  "BD",
                  "NR",
                  "LK",
                  "UG",
                  "NG",
                  "BQ",
                  "MX",
                  "CW",
                  "SI",
                  "MN",
                  "CA",
                  "AX",
                  "VN",
                  "TW",
                  "JP",
                  "IO",
                  "RO",
                  "BG",
                  "GU",
                  "BR",
                  "AM",
                  "ZM",
                  "DJ",
                  "JE",
                  "AT",
                  "CM",
                  "SE",
                  "FJ",
                  "KZ",
                  "GL",
                  "GY",
                  "CX",
                  "MW",
                  "TN",
                  "ZA",
                  "TO",
                  "CY",
                  "MV",
                  "PN",
                  "RW",
                  "NI",
                  "KN",
                  "BJ",
                  "ET",
                  "GM",
                  "TZ",
                  "VC",
                  "FK",
                  "SD",
                  "MC",
                  "AU",
                  "CL",
                  "DK",
                  "FR",
                  "TC",
                  "CU",
                  "AL",
                  "MZ",
                  "BS",
                  "NE",
                  "GT",
                  "LI",
                  "NP",
                  "BF",
                  "PW",
                  "KW",
                  "IN",
                  "GA",
                  "TV",
                  "MO",
                  "SH",
                  "MD",
                  "CK",
                  "AR",
                  "SC",
                  "IE",
                  "ES",
                  "LB",
                  "BM",
                  "RE",
                  "KI",
                  "AG",
                  "MQ",
                  "SV",
                  "JO",
                  "TH",
                  "SO",
                  "MH",
                  "CG",
                  "KP",
                  "GF",
                  "BA",
                  "YT",
                  "GS",
                  "KE",
                  "PE",
                  "BT",
                  "SZ",
                  "CR",
                  "TD",
                  "DM",
                  "NC",
                  "GR",
                  "GG",
                  "HN",
                  "VI",
                  "CF",
                  "SN",
                  "AF",
                  "MP",
                  "PH",
                  "BY",
                  "LV",
                  "NO",
                  "EG",
                  "KH",
                  "IQ",
                  "LC",
                  "NZ",
                  "BL",
                  "UZ",
                  "ID",
                  "ER",
                  "VE",
                  "FM",
                  "SB",
                  "ME",
                  "AS",
                  "XK"
                ],
                "description": "Country"
              },
              "created_at": {
                "type": "string",
                "format": "date-time",
                "description": "Postal address creation date time - iso8601"
              },
              "updated_at": {
                "type": "string",
                "format": "date-time",
                "description": "Postal address last update date time - iso8601"
              }
            }
          },
          "postal_work": {
            "description": "User work postal address",
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "format": "int32",
                "description": "Unique ID"
              },
              "address_1": {
                "type": "string",
                "description": "Address line 1"
              },
              "address_2": {
                "type": "string",
                "description": "Address line 2"
              },
              "address_3": {
                "type": "string",
                "description": "Address line 3"
              },
              "city": {
                "type": "string",
                "description": "City"
              },
              "state": {
                "type": "string",
                "description": "State"
              },
              "postal_code": {
                "type": "string",
                "description": "Zip code"
              },
              "country": {
                "type": "string",
                "enum": [
                  "TJ",
                  "JM",
                  "HT",
                  "ST",
                  "MS",
                  "AE",
                  "PK",
                  "NL",
                  "LU",
                  "BZ",
                  "IR",
                  "BO",
                  "UY",
                  "GH",
                  "SA",
                  "CI",
                  "MF",
                  "TF",
                  "AI",
                  "QA",
                  "SX",
                  "LY",
                  "BV",
                  "PG",
                  "KG",
                  "GQ",
                  "EH",
                  "NU",
                  "PR",
                  "GD",
                  "KR",
                  "HM",
                  "SM",
                  "SL",
                  "CD",
                  "MK",
                  "TR",
                  "DZ",
                  "GE",
                  "PS",
                  "BB",
                  "UA",
                  "GP",
                  "PF",
                  "NA",
                  "BW",
                  "SY",
                  "TG",
                  "DO",
                  "AQ",
                  "CH",
                  "MG",
                  "FO",
                  "VG",
                  "GI",
                  "BN",
                  "LA",
                  "IS",
                  "EE",
                  "UM",
                  "LT",
                  "RS",
                  "MR",
                  "AD",
                  "HU",
                  "TK",
                  "MY",
                  "AO",
                  "CV",
                  "NF",
                  "PA",
                  "GW",
                  "BE",
                  "PT",
                  "GB",
                  "IM",
                  "US",
                  "YE",
                  "HK",
                  "AZ",
                  "CC",
                  "ML",
                  "SK",
                  "VU",
                  "TL",
                  "HR",
                  "SR",
                  "MU",
                  "CZ",
                  "PM",
                  "LS",
                  "WS",
                  "KM",
                  "IT",
                  "BI",
                  "WF",
                  "GN",
                  "SG",
                  "CO",
                  "CN",
                  "AW",
                  "MA",
                  "FI",
                  "VA",
                  "ZW",
                  "KY",
                  "BH",
                  "PY",
                  "EC",
                  "LR",
                  "RU",
                  "PL",
                  "OM",
                  "MT",
                  "SS",
                  "DE",
                  "TM",
                  "SJ",
                  "MM",
                  "TT",
                  "IL",
                  "BD",
                  "NR",
                  "LK",
                  "UG",
                  "NG",
                  "BQ",
                  "MX",
                  "CW",
                  "SI",
                  "MN",
                  "CA",
                  "AX",
                  "VN",
                  "TW",
                  "JP",
                  "IO",
                  "RO",
                  "BG",
                  "GU",
                  "BR",
                  "AM",
                  "ZM",
                  "DJ",
                  "JE",
                  "AT",
                  "CM",
                  "SE",
                  "FJ",
                  "KZ",
                  "GL",
                  "GY",
                  "CX",
                  "MW",
                  "TN",
                  "ZA",
                  "TO",
                  "CY",
                  "MV",
                  "PN",
                  "RW",
                  "NI",
                  "KN",
                  "BJ",
                  "ET",
                  "GM",
                  "TZ",
                  "VC",
                  "FK",
                  "SD",
                  "MC",
                  "AU",
                  "CL",
                  "DK",
                  "FR",
                  "TC",
                  "CU",
                  "AL",
                  "MZ",
                  "BS",
                  "NE",
                  "GT",
                  "LI",
                  "NP",
                  "BF",
                  "PW",
                  "KW",
                  "IN",
                  "GA",
                  "TV",
                  "MO",
                  "SH",
                  "MD",
                  "CK",
                  "AR",
                  "SC",
                  "IE",
                  "ES",
                  "LB",
                  "BM",
                  "RE",
                  "KI",
                  "AG",
                  "MQ",
                  "SV",
                  "JO",
                  "TH",
                  "SO",
                  "MH",
                  "CG",
                  "KP",
                  "GF",
                  "BA",
                  "YT",
                  "GS",
                  "KE",
                  "PE",
                  "BT",
                  "SZ",
                  "CR",
                  "TD",
                  "DM",
                  "NC",
                  "GR",
                  "GG",
                  "HN",
                  "VI",
                  "CF",
                  "SN",
                  "AF",
                  "MP",
                  "PH",
                  "BY",
                  "LV",
                  "NO",
                  "EG",
                  "KH",
                  "IQ",
                  "LC",
                  "NZ",
                  "BL",
                  "UZ",
                  "ID",
                  "ER",
                  "VE",
                  "FM",
                  "SB",
                  "ME",
                  "AS",
                  "XK"
                ],
                "description": "Country"
              },
              "created_at": {
                "type": "string",
                "format": "date-time",
                "description": "Postal address creation date time - iso8601"
              },
              "updated_at": {
                "type": "string",
                "format": "date-time",
                "description": "Postal address last update date time - iso8601"
              }
            }
          },
          "preferred_postal_address": {
            "type": "string",
            "enum": [
              "postal_personal",
              "postal_work"
            ],
            "description": "User preferred postal address"
          },
          "config": {
            "description": "User specific configuration",
            "type": "object",
            "properties": {
              "private_profile": {
                "type": "boolean",
                "description": "Unique ID"
              },
              "opt_out_of_directory": {
                "type": "boolean",
                "description": "Unique ID"
              },
              "share_gender": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of gender"
              },
              "share_prefix_firstname": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of prefix_firstname"
              },
              "share_honorary_title": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of honorary_title"
              },
              "share_prefix_name": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of prefix_name"
              },
              "share_suffix_name": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of suffix_name"
              },
              "share_maidenname": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of maidenname"
              },
              "share_birthday": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of birthday"
              },
              "share_birthplace": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of birthplace"
              },
              "share_headline": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of headline"
              },
              "share_nationalities": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of nationalities"
              },
              "share_live_location": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of live_location"
              },
              "share_sub_networks": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of sub_networks"
              },
              "share_resume": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of resume"
              },
              "share_summary": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of summary"
              },
              "share_industries": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of industries"
              },
              "share_skills": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of skills"
              },
              "share_facebook_profile_url": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of facebook_profile_url"
              },
              "share_instagram_profile_url": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of instagram_profile_url"
              },
              "share_twitter": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of twitter"
              },
              "share_skype": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of skype"
              },
              "share_linkedin_profile_url": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of linkedin_profile_url"
              },
              "share_website": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of website"
              },
              "share_bbm": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of bbm"
              },
              "share_email": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of email"
              },
              "share_email2": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of email2"
              },
              "share_email3": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of email3"
              },
              "share_mobile_perso": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of mobile_perso"
              },
              "share_landline_perso": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of landline_perso"
              },
              "share_mobile_pro": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of mobile_pro"
              },
              "share_landline_pro": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of landline_pro"
              },
              "share_postal_personal": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of postal_personal"
              },
              "share_postal_work": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of postal_work"
              },
              "share_memberships": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of memberships"
              },
              "share_educations": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of educations"
              },
              "share_experiences": {
                "type": "string",
                "enum": [
                  "with_admin",
                  "with_all",
                  "with_bookmarked_users"
                ],
                "description": "Privacy sharing status of experiences"
              }
            }
          },
          "role_id": {
            "type": "integer",
            "format": "int32",
            "description": "User role ID"
          },
          "awards": {
            "type": "string",
            "description": "User awards"
          },
          "linkedin_profile_url": {
            "type": "string",
            "description": "User linkedin profile URL"
          },
          "website": {
            "type": "string",
            "description": "User Website URL"
          },
          "skype": {
            "type": "string",
            "description": "User skype profile"
          },
          "bbm": {
            "type": "string",
            "description": "User BlackBerry Messenger profile"
          },
          "twitter": {
            "type": "string",
            "description": "User twitter profile"
          },
          "timezone": {
            "type": "string",
            "enum": [
              "Africa/Abidjan",
              "Africa/Accra",
              "Africa/Algiers",
              "Africa/Bissau",
              "Africa/Cairo",
              "Africa/Casablanca",
              "Africa/Ceuta",
              "Africa/El_Aaiun",
              "Africa/Johannesburg",
              "Africa/Juba",
              "Africa/Khartoum",
              "Africa/Lagos",
              "Africa/Maputo",
              "Africa/Monrovia",
              "Africa/Nairobi",
              "Africa/Ndjamena",
              "Africa/Sao_Tome",
              "Africa/Tripoli",
              "Africa/Tunis",
              "Africa/Windhoek",
              "America/Adak",
              "America/Anchorage",
              "America/Araguaina",
              "America/Argentina/Buenos_Aires",
              "America/Argentina/Catamarca",
              "America/Argentina/Cordoba",
              "America/Argentina/Jujuy",
              "America/Argentina/La_Rioja",
              "America/Argentina/Mendoza",
              "America/Argentina/Rio_Gallegos",
              "America/Argentina/Salta",
              "America/Argentina/San_Juan",
              "America/Argentina/San_Luis",
              "America/Argentina/Tucuman",
              "America/Argentina/Ushuaia",
              "America/Asuncion",
              "America/Atikokan",
              "America/Bahia",
              "America/Bahia_Banderas",
              "America/Barbados",
              "America/Belem",
              "America/Belize",
              "America/Blanc-Sablon",
              "America/Boa_Vista",
              "America/Bogota",
              "America/Boise",
              "America/Cambridge_Bay",
              "America/Campo_Grande",
              "America/Cancun",
              "America/Caracas",
              "America/Cayenne",
              "America/Chicago",
              "America/Chihuahua",
              "America/Costa_Rica",
              "America/Creston",
              "America/Cuiaba",
              "America/Curacao",
              "America/Danmarkshavn",
              "America/Dawson",
              "America/Dawson_Creek",
              "America/Denver",
              "America/Detroit",
              "America/Edmonton",
              "America/Eirunepe",
              "America/El_Salvador",
              "America/Fort_Nelson",
              "America/Fortaleza",
              "America/Glace_Bay",
              "America/Goose_Bay",
              "America/Grand_Turk",
              "America/Guatemala",
              "America/Guayaquil",
              "America/Guyana",
              "America/Halifax",
              "America/Havana",
              "America/Hermosillo",
              "America/Indiana/Indianapolis",
              "America/Indiana/Knox",
              "America/Indiana/Marengo",
              "America/Indiana/Petersburg",
              "America/Indiana/Tell_City",
              "America/Indiana/Vevay",
              "America/Indiana/Vincennes",
              "America/Indiana/Winamac",
              "America/Inuvik",
              "America/Iqaluit",
              "America/Jamaica",
              "America/Juneau",
              "America/Kentucky/Louisville",
              "America/Kentucky/Monticello",
              "America/La_Paz",
              "America/Lima",
              "America/Los_Angeles",
              "America/Maceio",
              "America/Managua",
              "America/Manaus",
              "America/Martinique",
              "America/Matamoros",
              "America/Mazatlan",
              "America/Menominee",
              "America/Merida",
              "America/Metlakatla",
              "America/Mexico_City",
              "America/Miquelon",
              "America/Moncton",
              "America/Monterrey",
              "America/Montevideo",
              "America/Nassau",
              "America/New_York",
              "America/Nipigon",
              "America/Nome",
              "America/Noronha",
              "America/North_Dakota/Beulah",
              "America/North_Dakota/Center",
              "America/North_Dakota/New_Salem",
              "America/Nuuk",
              "America/Ojinaga",
              "America/Panama",
              "America/Pangnirtung",
              "America/Paramaribo",
              "America/Phoenix",
              "America/Port-au-Prince",
              "America/Port_of_Spain",
              "America/Porto_Velho",
              "America/Puerto_Rico",
              "America/Punta_Arenas",
              "America/Rainy_River",
              "America/Rankin_Inlet",
              "America/Recife",
              "America/Regina",
              "America/Resolute",
              "America/Rio_Branco",
              "America/Santarem",
              "America/Santiago",
              "America/Santo_Domingo",
              "America/Sao_Paulo",
              "America/Scoresbysund",
              "America/Sitka",
              "America/St_Johns",
              "America/Swift_Current",
              "America/Tegucigalpa",
              "America/Thule",
              "America/Thunder_Bay",
              "America/Tijuana",
              "America/Toronto",
              "America/Vancouver",
              "America/Whitehorse",
              "America/Winnipeg",
              "America/Yakutat",
              "America/Yellowknife",
              "Antarctica/Casey",
              "Antarctica/Davis",
              "Antarctica/DumontDUrville",
              "Antarctica/Macquarie",
              "Antarctica/Mawson",
              "Antarctica/Palmer",
              "Antarctica/Rothera",
              "Antarctica/Syowa",
              "Antarctica/Troll",
              "Antarctica/Vostok",
              "Asia/Almaty",
              "Asia/Amman",
              "Asia/Anadyr",
              "Asia/Aqtau",
              "Asia/Aqtobe",
              "Asia/Ashgabat",
              "Asia/Atyrau",
              "Asia/Baghdad",
              "Asia/Baku",
              "Asia/Bangkok",
              "Asia/Barnaul",
              "Asia/Beirut",
              "Asia/Bishkek",
              "Asia/Brunei",
              "Asia/Chita",
              "Asia/Choibalsan",
              "Asia/Colombo",
              "Asia/Damascus",
              "Asia/Dhaka",
              "Asia/Dili",
              "Asia/Dubai",
              "Asia/Dushanbe",
              "Asia/Famagusta",
              "Asia/Gaza",
              "Asia/Hebron",
              "Asia/Ho_Chi_Minh",
              "Asia/Hong_Kong",
              "Asia/Hovd",
              "Asia/Irkutsk",
              "Asia/Jakarta",
              "Asia/Jayapura",
              "Asia/Jerusalem",
              "Asia/Kabul",
              "Asia/Kamchatka",
              "Asia/Karachi",
              "Asia/Kathmandu",
              "Asia/Khandyga",
              "Asia/Kolkata",
              "Asia/Krasnoyarsk",
              "Asia/Kuala_Lumpur",
              "Asia/Kuching",
              "Asia/Macau",
              "Asia/Magadan",
              "Asia/Makassar",
              "Asia/Manila",
              "Asia/Nicosia",
              "Asia/Novokuznetsk",
              "Asia/Novosibirsk",
              "Asia/Omsk",
              "Asia/Oral",
              "Asia/Pontianak",
              "Asia/Pyongyang",
              "Asia/Qatar",
              "Asia/Qostanay",
              "Asia/Qyzylorda",
              "Asia/Riyadh",
              "Asia/Sakhalin",
              "Asia/Samarkand",
              "Asia/Seoul",
              "Asia/Shanghai",
              "Asia/Singapore",
              "Asia/Srednekolymsk",
              "Asia/Taipei",
              "Asia/Tashkent",
              "Asia/Tbilisi",
              "Asia/Tehran",
              "Asia/Thimphu",
              "Asia/Tokyo",
              "Asia/Tomsk",
              "Asia/Ulaanbaatar",
              "Asia/Urumqi",
              "Asia/Ust-Nera",
              "Asia/Vladivostok",
              "Asia/Yakutsk",
              "Asia/Yangon",
              "Asia/Yekaterinburg",
              "Asia/Yerevan",
              "Atlantic/Azores",
              "Atlantic/Bermuda",
              "Atlantic/Canary",
              "Atlantic/Cape_Verde",
              "Atlantic/Faroe",
              "Atlantic/Madeira",
              "Atlantic/Reykjavik",
              "Atlantic/South_Georgia",
              "Atlantic/Stanley",
              "Australia/Adelaide",
              "Australia/Brisbane",
              "Australia/Broken_Hill",
              "Australia/Currie",
              "Australia/Darwin",
              "Australia/Eucla",
              "Australia/Hobart",
              "Australia/Lindeman",
              "Australia/Lord_Howe",
              "Australia/Melbourne",
              "Australia/Perth",
              "Australia/Sydney",
              "CET",
              "CST6CDT",
              "EET",
              "EST",
              "EST5EDT",
              "Etc/GMT",
              "Etc/GMT+1",
              "Etc/GMT+10",
              "Etc/GMT+11",
              "Etc/GMT+12",
              "Etc/GMT+2",
              "Etc/GMT+3",
              "Etc/GMT+4",
              "Etc/GMT+5",
              "Etc/GMT+6",
              "Etc/GMT+7",
              "Etc/GMT+8",
              "Etc/GMT+9",
              "Etc/GMT-1",
              "Etc/GMT-10",
              "Etc/GMT-11",
              "Etc/GMT-12",
              "Etc/GMT-13",
              "Etc/GMT-14",
              "Etc/GMT-2",
              "Etc/GMT-3",
              "Etc/GMT-4",
              "Etc/GMT-5",
              "Etc/GMT-6",
              "Etc/GMT-7",
              "Etc/GMT-8",
              "Etc/GMT-9",
              "Etc/UTC",
              "Europe/Amsterdam",
              "Europe/Andorra",
              "Europe/Astrakhan",
              "Europe/Athens",
              "Europe/Belgrade",
              "Europe/Berlin",
              "Europe/Brussels",
              "Europe/Bucharest",
              "Europe/Budapest",
              "Europe/Chisinau",
              "Europe/Copenhagen",
              "Europe/Dublin",
              "Europe/Gibraltar",
              "Europe/Helsinki",
              "Europe/Istanbul",
              "Europe/Kaliningrad",
              "Europe/Kiev",
              "Europe/Kirov",
              "Europe/Lisbon",
              "Europe/London",
              "Europe/Luxembourg",
              "Europe/Madrid",
              "Europe/Malta",
              "Europe/Minsk",
              "Europe/Monaco",
              "Europe/Moscow",
              "Europe/Oslo",
              "Europe/Paris",
              "Europe/Prague",
              "Europe/Riga",
              "Europe/Rome",
              "Europe/Samara",
              "Europe/Saratov",
              "Europe/Simferopol",
              "Europe/Sofia",
              "Europe/Stockholm",
              "Europe/Tallinn",
              "Europe/Tirane",
              "Europe/Ulyanovsk",
              "Europe/Uzhgorod",
              "Europe/Vienna",
              "Europe/Vilnius",
              "Europe/Volgograd",
              "Europe/Warsaw",
              "Europe/Zaporozhye",
              "Europe/Zurich",
              "Factory",
              "HST",
              "Indian/Chagos",
              "Indian/Christmas",
              "Indian/Cocos",
              "Indian/Kerguelen",
              "Indian/Mahe",
              "Indian/Maldives",
              "Indian/Mauritius",
              "Indian/Reunion",
              "MET",
              "MST",
              "MST7MDT",
              "PST8PDT",
              "Pacific/Apia",
              "Pacific/Auckland",
              "Pacific/Bougainville",
              "Pacific/Chatham",
              "Pacific/Chuuk",
              "Pacific/Easter",
              "Pacific/Efate",
              "Pacific/Enderbury",
              "Pacific/Fakaofo",
              "Pacific/Fiji",
              "Pacific/Funafuti",
              "Pacific/Galapagos",
              "Pacific/Gambier",
              "Pacific/Guadalcanal",
              "Pacific/Guam",
              "Pacific/Honolulu",
              "Pacific/Kiritimati",
              "Pacific/Kosrae",
              "Pacific/Kwajalein",
              "Pacific/Majuro",
              "Pacific/Marquesas",
              "Pacific/Nauru",
              "Pacific/Niue",
              "Pacific/Norfolk",
              "Pacific/Noumea",
              "Pacific/Pago_Pago",
              "Pacific/Palau",
              "Pacific/Pitcairn",
              "Pacific/Pohnpei",
              "Pacific/Port_Moresby",
              "Pacific/Rarotonga",
              "Pacific/Tahiti",
              "Pacific/Tarawa",
              "Pacific/Tongatapu",
              "Pacific/Wake",
              "Pacific/Wallis",
              "WET"
            ],
            "description": "User timezone"
          },
          "facebook_profile_url": {
            "type": "string",
            "description": "User facebook profile URL"
          },
          "instagram_profile_url": {
            "type": "string",
            "description": "User instagram profile URL"
          },
          "honorary_title": {
            "type": "string",
            "enum": [
              "mr",
              "mrs",
              "ms",
              "dr",
              "prof"
            ],
            "description": "User's honorary title"
          },
          "live_location": {
            "description": "User's current location. READ only, can't be updated",
            "type": "object",
            "properties": {
              "address": {
                "type": "string",
                "description": "Address"
              },
              "lat": {
                "type": "number",
                "format": "float",
                "description": "Latitude"
              },
              "lng": {
                "type": "number",
                "format": "float",
                "description": "Longitude"
              },
              "city": {
                "type": "string",
                "description": "City"
              },
              "country": {
                "type": "string",
                "description": "State"
              },
              "country_code": {
                "type": "string",
                "description": "Zip code"
              }
            }
          },
          "resume": {
            "type": "string",
            "description": "URL link to the user's resume"
          },
          "locale": {
            "type": "string",
            "enum": [
              "en",
              "en-GB",
              "fr",
              "he",
              "de",
              "es",
              "it",
              "da",
              "nl",
              "pt",
              "ru",
              "deepbloo",
              "zh-Hans",
              "zh-Hant",
              "af",
              "pl",
              "fi",
              "nl-BE",
              "nb"
            ],
            "description": "User Locale"
          },
          "share_email": {
            "type": "string",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ],
            "description": "User's visibility information regarding email"
          },
          "share_email2": {
            "type": "string",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ],
            "description": "User's visibility information regarding secondary email"
          },
          "share_email3": {
            "type": "string",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ],
            "description": "User's visibility information regarding complementary email"
          },
          "share_postal_address_personal": {
            "type": "string",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ],
            "description": "User's visibility information regarding postal home location"
          },
          "share_postal_address_work": {
            "type": "string",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ],
            "description": "User's visibility information regarding postal work location"
          },
          "share_nationalities": {
            "type": "string",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ],
            "description": "User's visibility information regarding nationalities"
          },
          "share_resume": {
            "type": "string",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ],
            "description": "User's visibility information regarding resume"
          },
          "share_mobile_pro": {
            "type": "string",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ],
            "description": "User's visibility information regarding work mobile phone"
          },
          "share_mobile_perso": {
            "type": "string",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ],
            "description": "User's visibility information regarding personal mobile phone"
          },
          "share_landline_pro": {
            "type": "string",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ],
            "description": "User's visibility information regarding professional landline phone"
          },
          "share_landline_perso": {
            "type": "string",
            "enum": [
              "with_admin",
              "with_all",
              "with_bookmarked_users"
            ],
            "description": "User's visibility information regarding personal landline phone"
          },
          "custom_attributes": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Array of customizable attributes with name, value and type"
          }
        },
        "description": "User model"
      }
    }
  },
  "description": "Users model"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "Error model"
}

Bulk update of existing users
PUT/api/admin/v1/users/_bulk

Batch update of users

Find users using the ID setted in the users hash, or set external_id or previous_id as the key parameter to fetch users on these identifier instead of default ID, and set the correct value for the ID params in users. Photo and resume must be sent as files (URL to files won’t work)

WARNING: Swagger generated exemple of the parameters is false! You should use an array of users data

{
  "users": [
    // User 1
    {
      "id": 1,
      "email": "string",
      "sub_network_ids": [
        0
      ],
      ...
    },
    // User 2
    {
      "id": 2,
      "email": "string",
      "sub_network_ids": [
        0
      ],
      ...
    }
  ]
}

Errors

If any users failed to update, the whole transaction is rollbacked


POST /api/admin/v1/users/_bulk
Requests
Body
{
  "users[email]": [],
  "users[sub_network_ids]": [],
  "users[postal_personal][address_1]": [],
  "users[postal_personal][address_2]": [],
  "users[postal_personal][address_3]": [],
  "users[postal_personal][city]": [],
  "users[postal_personal][state]": [],
  "users[postal_personal][postal_code]": [],
  "users[postal_personal][country]": [],
  "users[postal_personal][default_billing_address]": [],
  "users[postal_personal][created_at]": [],
  "users[postal_personal][updated_at]": [],
  "users[postal_work][address_1]": [],
  "users[postal_work][address_2]": [],
  "users[postal_work][address_3]": [],
  "users[postal_work][city]": [],
  "users[postal_work][state]": [],
  "users[postal_work][postal_code]": [],
  "users[postal_work][country]": [],
  "users[postal_work][default_billing_address]": [],
  "users[postal_work][created_at]": [],
  "users[postal_work][updated_at]": [],
  "users[config][private_profile]": [],
  "users[config][opt_out_of_directory]": [],
  "users[config][share_gender]": [],
  "users[config][share_prefix_firstname]": [],
  "users[config][share_honorary_title]": [],
  "users[config][share_prefix_name]": [],
  "users[config][share_suffix_name]": [],
  "users[config][share_maidenname]": [],
  "users[config][share_birthday]": [],
  "users[config][share_birthplace]": [],
  "users[config][share_headline]": [],
  "users[config][share_nationalities]": [],
  "users[config][share_live_location]": [],
  "users[config][share_sub_networks]": [],
  "users[config][share_resume]": [],
  "users[config][share_summary]": [],
  "users[config][share_industries]": [],
  "users[config][share_skills]": [],
  "users[config][share_facebook_profile_url] (array) - Privacy sharing status of facebook_profile_url": "Hello, world!",
  "users[config][share_instagram_profile_url] (array) - Privacy sharing status of instagram_profile_url": "Hello, world!",
  "users[config][share_twitter]": [],
  "users[config][share_skype]": [],
  "users[config][share_linkedin_profile_url] (array) - Privacy sharing status of linkedin_profile_url": "Hello, world!",
  "users[config][share_website]": [],
  "users[config][share_bbm]": [],
  "users[config][share_email]": [],
  "users[config][share_email2]": [],
  "users[config][share_email3]": [],
  "users[config][share_mobile_perso]": [],
  "users[config][share_landline_perso]": [],
  "users[config][share_mobile_pro]": [],
  "users[config][share_landline_pro]": [],
  "users[config][share_postal_personal]": [],
  "users[config][share_postal_work]": [],
  "users[config][share_memberships]": [],
  "users[config][share_educations]": [],
  "users[config][share_experiences]": [],
  "users[extended_updated_at]": [],
  "users[email2]": [],
  "users[email3]": [],
  "users[primary_email_choice]": [],
  "users[firstname]": [],
  "users[lastname]": [],
  "users[maidenname]": [],
  "users[prefix_firstname]": [],
  "users[prefix_name]": [],
  "users[suffix_name]": [],
  "users[external_id]": [],
  "users[sso_identifier]": [],
  "users[previous_id]": [],
  "users[is_active]": [
    true
  ],
  "users[gender]": [],
  "users[birthday]": [],
  "users[birthplace]": [],
  "users[headline]": [],
  "users[summary]": [],
  "users[created_at]": [],
  "users[updated_at]": [],
  "users[citizenship_ids]": [],
  "users[citizenship_country_codes]": [],
  "users[deceased]": [
    true
  ],
  "users[deceased_at]": [],
  "users[do_not_contact]": [
    true
  ],
  "users[mobile_perso]": [],
  "users[mobile_pro]": [],
  "users[landline_perso]": [],
  "users[landline_pro]": [],
  "users[preferred_phone_number]": [],
  "users[preferred_postal_address]": [],
  "users[role_id]": [
    1
  ],
  "users[awards]": [],
  "users[linkedin_profile_url]": [],
  "users[website]": [],
  "users[skype]": [],
  "users[bbm]": [],
  "users[twitter]": [],
  "users[timezone]": [],
  "users[facebook_profile_url]": [],
  "users[instagram_profile_url]": [],
  "users[honorary_title]": [],
  "users[locale]": [],
  "users[share_email]": [],
  "users[share_email2]": [],
  "users[share_email3]": [],
  "users[share_postal_address_personal]": [],
  "users[share_postal_address_work]": [],
  "users[share_nationalities]": [],
  "users[share_resume]": [],
  "users[share_mobile_pro]": [],
  "users[share_mobile_perso]": [],
  "users[share_landline_pro]": [],
  "users[share_landline_perso]": [],
  "users[custom_attributes]": [],
  "users[photo]": [],
  "users[resume]": [],
  "users[notify_after_create]": []
}
Schema
{
  "type": "object",
  "properties": {
    "users[email]": {
      "type": "array",
      "description": "User email\n\n+"
    },
    "users[sub_network_ids]": {
      "type": "array",
      "description": "User sub networks ids\n\n+"
    },
    "users[postal_personal][address_1]": {
      "type": "array",
      "description": "Address line 1\n\n+"
    },
    "users[postal_personal][address_2]": {
      "type": "array",
      "description": "Address line 2\n\n+"
    },
    "users[postal_personal][address_3]": {
      "type": "array",
      "description": "Address line 3\n\n+"
    },
    "users[postal_personal][city]": {
      "type": "array",
      "description": "City\n\n+"
    },
    "users[postal_personal][state]": {
      "type": "array",
      "description": "State\n\n+"
    },
    "users[postal_personal][postal_code]": {
      "type": "array",
      "description": "Zip code\n\n+"
    },
    "users[postal_personal][country]": {
      "type": "array",
      "description": "Country\n\n+"
    },
    "users[postal_personal][default_billing_address]": {
      "type": "array",
      "description": "is the default billing address for the user ?\n\n+"
    },
    "users[postal_personal][created_at]": {
      "type": "array",
      "description": "Postal address creation date time - iso8601\n\n+"
    },
    "users[postal_personal][updated_at]": {
      "type": "array",
      "description": "Postal address last update date time - iso8601\n\n+"
    },
    "users[postal_work][address_1]": {
      "type": "array",
      "description": "Address line 1\n\n+"
    },
    "users[postal_work][address_2]": {
      "type": "array",
      "description": "Address line 2\n\n+"
    },
    "users[postal_work][address_3]": {
      "type": "array",
      "description": "Address line 3\n\n+"
    },
    "users[postal_work][city]": {
      "type": "array",
      "description": "City\n\n+"
    },
    "users[postal_work][state]": {
      "type": "array",
      "description": "State\n\n+"
    },
    "users[postal_work][postal_code]": {
      "type": "array",
      "description": "Zip code\n\n+"
    },
    "users[postal_work][country]": {
      "type": "array",
      "description": "Country\n\n+"
    },
    "users[postal_work][default_billing_address]": {
      "type": "array",
      "description": "is the default billing address for the user ?\n\n+"
    },
    "users[postal_work][created_at]": {
      "type": "array",
      "description": "Postal address creation date time - iso8601\n\n+"
    },
    "users[postal_work][updated_at]": {
      "type": "array",
      "description": "Postal address last update date time - iso8601\n\n+"
    },
    "users[config][private_profile]": {
      "type<