Hivebrite Admin API

Swagger documentation for the Hivebrite Admin API

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"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Admin creation  date"
    }
  },
  "description": "Current admin is the owner of the *access_token* used in the request."
}

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/customizable_attributes
Responses200

Get all customizable attributes

Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "Unique ID"
    },
    "type": {
      "type": "string",
      "description": "Customizable Attribute type"
    },
    "customizable_type": {
      "type": "string",
      "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": "string",
      "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": "Return this network customizable attributes."
}

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

Return this network customizable attributes.


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": "Return this network field of studies."
}

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

Return this network field of studies.


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": "Return this network industries."
}

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

Return this network industries.


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": "Return this network job functions."
}

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

Return this network job functions.


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": "Return this network customizable attributes for Education in a zapier-compatible format"
}

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


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": "Return this network customizable attributes for Education in a zapier-compatible format"
}

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/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": "Return this network customizable attributes for Education in a zapier-compatible format"
}

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


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"
        }
      }
    }
  },
  "required": [
    "title",
    "sub_networks"
  ],
  "description": "Return this network information."
}

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

Return this network information.


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": "Return the created sub network"
}

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": "Return all citizenships"
}

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

Return all citizenships


experiences

Operations about experiences

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"
          },
          "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"
              }
            }
          },
          "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"
          },
          "extended_updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Experience (including custom attributes) last update date time - iso8601"
          }
        },
        "description": "## Update a user experience\n\nFind the user experience matching its ID, or use `external_id` as the **experience_key** parameter to identify the experience instead of default ID.\n\n"
      }
    }
  },
  "description": "\n## Return an array of experiences with basic information\n\nUse the param `updated_since` to fetch all experiences updated\nsince this datetime (e.g. `updated_since=2017-08-01T00:00:00`)\n\nUse the param `order` to choose on which criterias the results\nshould be ordered (e.g. `order=extended_updated_at` to order by\nextended_updated_at descending, use the minus operator to order\nby ascending value e.g. `order=-extended_updated_at`).\n\nPagination information are stored in the response header as defined by RFC-5988\nhttp://tools.ietf.org/html/rfc5988\n\nExample:\n```json\n{\n\"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\\\"\",\n\"x-per-page\": \"30\",\n\"x-total\": \"10201\",\n\"x-page\": \"4\"\n}\n```\n\n"
}

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=extended_updated_at to order by extended_updated_at descending, use the minus operator to order by ascending value e.g. order=-extended_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.


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"
    },
    "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"
        }
      }
    },
    "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"
    },
    "extended_updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience (including custom attributes) last update date time - iso8601"
    }
  },
  "description": "## Update a user experience\n\nFind the user experience matching its ID, or use `external_id` as the **experience_key** parameter to identify the experience instead of default ID.\n\n"
}

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) 

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"
    },
    "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"
        }
      }
    },
    "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"
    },
    "extended_updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Experience (including custom attributes) last update date time - iso8601"
    }
  },
  "description": "## Update a user experience\n\nFind the user experience matching its ID, or use `external_id` as the **experience_key** parameter to identify the experience instead of default ID.\n\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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


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) 

users

Operations about users

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"
          }
        },
        "description": "## Update a user experience\n\nFind 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.\n\n"
      }
    }
  },
  "description": "# Batch update of user experiences\n\nFind user experiences using the ID setted in the `experiences` hash, linked to the user set with the user ID\nor set `external_id` or `previous_id` as the **key** parameter to fetch user on this\nidentifier instead of default ID, and set the correct value for the ID params in `users`.\n\nWARNING: Swagger generated exemple of the parameters is false! You should use an **array** of user experiences data\n\n```json\n{\n  \"experiences\": [\n    // experience 1\n    {\n      \"id\": 1,\n      \"position\": \"string\",\n      \"companies_company_id\": 0\n      ...\n    },\n    // experience 2\n    {\n      \"id\": 2,\n      \"position\": \"string\",\n      \"companies_company_id\": 0\n      ...\n    },\n  ]\n}\n```\n\n# Errors\n\nIf any user experiences failed to update, the whole transaction is rollbacked\n"
}

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) 

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"
    }
  },
  "description": "## Update a user experience\n\nFind 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.\n\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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/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"
    }
  },
  "description": "## Update a user experience\n\nFind 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.\n\n"
}

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/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"
    }
  },
  "description": "## Update a user experience\n\nFind 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.\n\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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) 

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) 

POST /api/admin/v1/users/user_id/experiences/_bulk
Requests
Body
{
  "key": "Hello, world!",
  "experiences": [],
  "experiences[position]": "Hello, world!",
  "experiences[companies_company_id]": "Hello, world!",
  "experiences[companies_company_key]": "Hello, world!",
  "experiences[from]": [],
  "experiences[to]": [],
  "experiences[custom_attributes]": [],
  "experiences[industry_id]": 1,
  "experiences[job_function_id]": 1,
  "experiences[external_id]": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "experiences": {
      "type": "array",
      "description": "Array of user experiences data\n\n+"
    },
    "experiences[position]": {
      "type": "string",
      "description": "User position"
    },
    "experiences[companies_company_id]": {
      "type": "string",
      "description": "Company linked to experience"
    },
    "experiences[companies_company_key]": {
      "type": "string"
    },
    "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": "number",
      "description": "Industry ID matching the experience"
    },
    "experiences[job_function_id]": {
      "type": "number",
      "description": "Job Function ID matching the experience"
    },
    "experiences[external_id]": {
      "type": "string",
      "description": "Experience ID in your database"
    }
  },
  "required": [
    "experiences",
    "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"
          }
        },
        "description": "## Update a user experience\n\nFind 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.\n\n"
      }
    }
  },
  "description": "# Batch update of user experiences\n\nFind user experiences using the ID setted in the `experiences` hash, linked to the user set with the user ID\nor set `external_id` or `previous_id` as the **key** parameter to fetch user on this\nidentifier instead of default ID, and set the correct value for the ID params in `users`.\n\nWARNING: Swagger generated exemple of the parameters is false! You should use an **array** of user experiences data\n\n```json\n{\n  \"experiences\": [\n    // experience 1\n    {\n      \"id\": 1,\n      \"position\": \"string\",\n      \"companies_company_id\": 0\n      ...\n    },\n    // experience 2\n    {\n      \"id\": 2,\n      \"position\": \"string\",\n      \"companies_company_id\": 0\n      ...\n    },\n  ]\n}\n```\n\n# Errors\n\nIf any user experiences failed to update, the whole transaction is rollbacked\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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) 

PUT /api/admin/v1/users/user_id/experiences/_bulk
Requests
Body
{
  "key": "Hello, world!",
  "experiences": [],
  "experiences[id]": "Hello, world!",
  "experiences[experience_key]": "Hello, world!",
  "experiences[companies_company_key]": "Hello, world!",
  "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]": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "experiences": {
      "type": "array",
      "description": "Array of user experiences data\n\n+"
    },
    "experiences[id]": {
      "type": "string",
      "description": "Experience ID"
    },
    "experiences[experience_key]": {
      "type": "string"
    },
    "experiences[companies_company_key]": {
      "type": "string"
    },
    "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": "number",
      "description": "Industry ID matching the experience"
    },
    "experiences[job_function_id]": {
      "type": "number",
      "description": "Job Function ID matching the experience"
    },
    "experiences[external_id]": {
      "type": "string",
      "description": "Experience ID in your database"
    }
  },
  "required": [
    "experiences",
    "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"
          }
        },
        "description": "## Update a user experience\n\nFind 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.\n\n"
      }
    }
  },
  "description": "# Batch update of user experiences\n\nFind user experiences using the ID setted in the `experiences` hash, linked to the user set with the user ID\nor set `external_id` or `previous_id` as the **key** parameter to fetch user on this\nidentifier instead of default ID, and set the correct value for the ID params in `users`.\n\nWARNING: Swagger generated exemple of the parameters is false! You should use an **array** of user experiences data\n\n```json\n{\n  \"experiences\": [\n    // experience 1\n    {\n      \"id\": 1,\n      \"position\": \"string\",\n      \"companies_company_id\": 0\n      ...\n    },\n    // experience 2\n    {\n      \"id\": 2,\n      \"position\": \"string\",\n      \"companies_company_id\": 0\n      ...\n    },\n  ]\n}\n```\n\n# Errors\n\nIf any user experiences failed to update, the whole transaction is rollbacked\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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) 

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"
          },
          "external_id": {
            "type": "string",
            "description": "Education ID in your database"
          }
        },
        "description": "## Update a user education\n\nFind 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.\n\n"
      }
    }
  },
  "description": "# Batch update of user educations\n\nFind user educations using the ID setted in the `educations` hash, linked to the user set with the user ID\nor set `external_id` or `previous_id` as the **key** parameter to fetch user on this\nidentifier instead of default ID, and set the correct value for the ID params in `users`.\n\nWARNING: Swagger generated exemple of the parameters is false! You should use an **array** of user educations data\n\n```json\n{\n  \"educations\": [\n    // education 1\n    {\n      \"id\": 1,\n      \"school_name\": \"string\",\n      ...\n    },\n    // education 2\n    {\n      \"id\": 2,\n      \"school_name\": \"string\",\n      ...\n    },\n  ]\n}\n```\n\n# Errors\n\nIf any user educations failed to update, the whole transaction is rollbacked\n"
}

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) 

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[external_id]": "Hello, world!"
}
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[external_id]": {
      "type": "string",
      "description": "Education ID in your database"
    }
  },
  "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"
    },
    "external_id": {
      "type": "string",
      "description": "Education ID in your database"
    }
  },
  "description": "## Update a user education\n\nFind 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.\n\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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/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"
    },
    "external_id": {
      "type": "string",
      "description": "Education ID in your database"
    }
  },
  "description": "## Update a user education\n\nFind 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.\n\n"
}

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/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[external_id]": "Hello, world!"
}
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[external_id]": {
      "type": "string",
      "description": "Education ID in your database"
    }
  },
  "$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"
    },
    "external_id": {
      "type": "string",
      "description": "Education ID in your database"
    }
  },
  "description": "## Update a user education\n\nFind 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.\n\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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) 

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) 

POST /api/admin/v1/users/user_id/educations/_bulk
Requests
Body
{
  "key": "Hello, world!",
  "educations": [],
  "educations[school_name]": "Hello, world!",
  "educations[id]": [
    1
  ],
  "educations[degree]": [],
  "educations[from]": [],
  "educations[to]": [],
  "educations[custom_attributes]": [],
  "educations[field_of_study_id]": 1,
  "educations[external_id]": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "educations": {
      "type": "array",
      "description": "Array of user educations data\n\n+"
    },
    "educations[school_name]": {
      "type": "string",
      "description": "School name"
    },
    "educations[id]": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Unique ID"
    },
    "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": "number",
      "description": "Field of study ID matching the education"
    },
    "educations[external_id]": {
      "type": "string",
      "description": "Education ID in your database"
    }
  },
  "required": [
    "educations",
    "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"
          },
          "external_id": {
            "type": "string",
            "description": "Education ID in your database"
          }
        },
        "description": "## Update a user education\n\nFind 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.\n\n"
      }
    }
  },
  "description": "# Batch update of user educations\n\nFind user educations using the ID setted in the `educations` hash, linked to the user set with the user ID\nor set `external_id` or `previous_id` as the **key** parameter to fetch user on this\nidentifier instead of default ID, and set the correct value for the ID params in `users`.\n\nWARNING: Swagger generated exemple of the parameters is false! You should use an **array** of user educations data\n\n```json\n{\n  \"educations\": [\n    // education 1\n    {\n      \"id\": 1,\n      \"school_name\": \"string\",\n      ...\n    },\n    // education 2\n    {\n      \"id\": 2,\n      \"school_name\": \"string\",\n      ...\n    },\n  ]\n}\n```\n\n# Errors\n\nIf any user educations failed to update, the whole transaction is rollbacked\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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) 

PUT /api/admin/v1/users/user_id/educations/_bulk
Requests
Body
{
  "key": "Hello, world!",
  "educations": [],
  "educations[education_key]": "Hello, world!",
  "educations[id]": "Hello, world!",
  "educations[degree]": [],
  "educations[from]": [],
  "educations[to]": [],
  "educations[custom_attributes]": [],
  "educations[field_of_study_id]": 1,
  "educations[external_id]": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "educations": {
      "type": "array",
      "description": "Array of user educations data\n\n+"
    },
    "educations[education_key]": {
      "type": "string"
    },
    "educations[id]": {
      "type": "string",
      "description": "Education ID"
    },
    "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": "number",
      "description": "Field of study ID matching the education"
    },
    "educations[external_id]": {
      "type": "string",
      "description": "Education ID in your database"
    }
  },
  "required": [
    "educations",
    "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"
          },
          "external_id": {
            "type": "string",
            "description": "Education ID in your database"
          }
        },
        "description": "## Update a user education\n\nFind 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.\n\n"
      }
    }
  },
  "description": "# Batch update of user educations\n\nFind user educations using the ID setted in the `educations` hash, linked to the user set with the user ID\nor set `external_id` or `previous_id` as the **key** parameter to fetch user on this\nidentifier instead of default ID, and set the correct value for the ID params in `users`.\n\nWARNING: Swagger generated exemple of the parameters is false! You should use an **array** of user educations data\n\n```json\n{\n  \"educations\": [\n    // education 1\n    {\n      \"id\": 1,\n      \"school_name\": \"string\",\n      ...\n    },\n    // education 2\n    {\n      \"id\": 2,\n      \"school_name\": \"string\",\n      ...\n    },\n  ]\n}\n```\n\n# Errors\n\nIf any user educations failed to update, the whole transaction is rollbacked\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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) 

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": "## Update a user membership\nFind the user membership matching this ID.\n"
}

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) 

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": "## Update a user membership\nFind the user membership matching this ID.\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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/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": "## Update a user membership\nFind the user membership matching this ID.\n"
}

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) 

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": "## Update a user membership\nFind the user membership matching this ID.\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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) 

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) 

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"
    },
    "trip_subnetwork_email": {
      "type": "boolean",
      "description": "Receive notifications for new trips within the user cluster"
    },
    "trip_industry_email": {
      "type": "boolean",
      "description": "Receive notifications for new trips within the user industries"
    },
    "trip_reminder_email": {
      "type": "boolean",
      "description": "Receive notifications for trips reminder"
    },
    "event_email": {
      "type": "boolean",
      "description": "Receive notifications for new user events"
    },
    "digest_email": {
      "type": "boolean",
      "description": "Receive notifications for new digests"
    },
    "network_events_event_email": {
      "type": "boolean",
      "description": "Receive notifications for new network events"
    },
    "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"
    },
    "invitation_email": {
      "type": "boolean",
      "description": "Receive notifications for new invitations"
    },
    "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": {
      "description": "Emailing campaigns categories subscribed",
      "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": "\n## Update this user notification settings\n\n"
}

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/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[trip_subnetwork_email]": true,
  "notification_settings[trip_industry_email]": true,
  "notification_settings[trip_reminder_email]": true,
  "notification_settings[event_email]": true,
  "notification_settings[digest_email]": true,
  "notification_settings[network_events_event_email]": true,
  "notification_settings[comment_email]": true,
  "notification_settings[ventures_comment_email]": true,
  "notification_settings[businessopportunities_request]": true,
  "notification_settings[invitation_email]": 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
}
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[trip_subnetwork_email]": {
      "type": "boolean",
      "description": "Receive notifications for new trips within the user cluster"
    },
    "notification_settings[trip_industry_email]": {
      "type": "boolean",
      "description": "Receive notifications for new trips within the user industries"
    },
    "notification_settings[trip_reminder_email]": {
      "type": "boolean",
      "description": "Receive notifications for trips reminder"
    },
    "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[network_events_event_email]": {
      "type": "boolean",
      "description": "Receive notifications for new network events"
    },
    "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[invitation_email]": {
      "type": "boolean",
      "description": "Receive notifications for new invitations"
    },
    "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"
    }
  },
  "$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"
    },
    "trip_subnetwork_email": {
      "type": "boolean",
      "description": "Receive notifications for new trips within the user cluster"
    },
    "trip_industry_email": {
      "type": "boolean",
      "description": "Receive notifications for new trips within the user industries"
    },
    "trip_reminder_email": {
      "type": "boolean",
      "description": "Receive notifications for trips reminder"
    },
    "event_email": {
      "type": "boolean",
      "description": "Receive notifications for new user events"
    },
    "digest_email": {
      "type": "boolean",
      "description": "Receive notifications for new digests"
    },
    "network_events_event_email": {
      "type": "boolean",
      "description": "Receive notifications for new network events"
    },
    "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"
    },
    "invitation_email": {
      "type": "boolean",
      "description": "Receive notifications for new invitations"
    },
    "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": {
      "description": "Emailing campaigns categories subscribed",
      "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": "\n## Update this user notification settings\n\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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/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": [
              "AD",
              "AE",
              "AF",
              "AG",
              "AI",
              "AL",
              "AM",
              "AO",
              "AQ",
              "AR",
              "AS",
              "AT",
              "AU",
              "AW",
              "AX",
              "AZ",
              "BA",
              "BB",
              "BD",
              "BE",
              "BF",
              "BG",
              "BH",
              "BI",
              "BJ",
              "BL",
              "BM",
              "BN",
              "BO",
              "BQ",
              "BR",
              "BS",
              "BT",
              "BV",
              "BW",
              "BY",
              "BZ",
              "CA",
              "CC",
              "CD",
              "CF",
              "CG",
              "CH",
              "CI",
              "CK",
              "CL",
              "CM",
              "CN",
              "CO",
              "CR",
              "CU",
              "CV",
              "CW",
              "CX",
              "CY",
              "CZ",
              "DE",
              "DJ",
              "DK",
              "DM",
              "DO",
              "DZ",
              "EC",
              "EE",
              "EG",
              "EH",
              "ER",
              "ES",
              "ET",
              "FI",
              "FJ",
              "FK",
              "FM",
              "FO",
              "FR",
              "GA",
              "GB",
              "GD",
              "GE",
              "GF",
              "GG",
              "GH",
              "GI",
              "GL",
              "GM",
              "GN",
              "GP",
              "GQ",
              "GR",
              "GS",
              "GT",
              "GU",
              "GW",
              "GY",
              "HK",
              "HM",
              "HN",
              "HR",
              "HT",
              "HU",
              "ID",
              "IE",
              "IL",
              "IM",
              "IN",
              "IO",
              "IQ",
              "IR",
              "IS",
              "IT",
              "JE",
              "JM",
              "JO",
              "JP",
              "KE",
              "KG",
              "KH",
              "KI",
              "KM",
              "KN",
              "KP",
              "KR",
              "KW",
              "KY",
              "KZ",
              "LA",
              "LB",
              "LC",
              "LI",
              "LK",
              "LR",
              "LS",
              "LT",
              "LU",
              "LV",
              "LY",
              "MA",
              "MC",
              "MD",
              "ME",
              "MF",
              "MG",
              "MH",
              "MK",
              "ML",
              "MM",
              "MN",
              "MO",
              "MP",
              "MQ",
              "MR",
              "MS",
              "MT",
              "MU",
              "MV",
              "MW",
              "MX",
              "MY",
              "MZ",
              "NA",
              "NC",
              "NE",
              "NF",
              "NG",
              "NI",
              "NL",
              "NO",
              "NP",
              "NR",
              "NU",
              "NZ",
              "OM",
              "PA",
              "PE",
              "PF",
              "PG",
              "PH",
              "PK",
              "PL",
              "PM",
              "PN",
              "PR",
              "PS",
              "PT",
              "PW",
              "PY",
              "QA",
              "RE",
              "RO",
              "RS",
              "RU",
              "RW",
              "SA",
              "SB",
              "SC",
              "SD",
              "SE",
              "SG",
              "SH",
              "SI",
              "SJ",
              "SK",
              "SL",
              "SM",
              "SN",
              "SO",
              "SR",
              "SS",
              "ST",
              "SV",
              "SX",
              "SY",
              "SZ",
              "TC",
              "TD",
              "TF",
              "TG",
              "TH",
              "TJ",
              "TK",
              "TL",
              "TM",
              "TN",
              "TO",
              "TR",
              "TT",
              "TV",
              "TW",
              "TZ",
              "UA",
              "UG",
              "UM",
              "US",
              "UY",
              "UZ",
              "VA",
              "VC",
              "VE",
              "VG",
              "VI",
              "VN",
              "VU",
              "WF",
              "WS",
              "YE",
              "YT",
              "ZA",
              "ZM",
              "ZW",
              "XK"
            ],
            "description": "Country"
          },
          "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"
          },
          "user_id": {
            "type": "integer",
            "format": "int32",
            "description": "User ID linked to postal address"
          }
        },
        "description": "## Update a postal address\n\n"
      }
    }
  },
  "description": "\n## Return an array of postal addresses\n\nUse the param `updated_since` to fetch all postal addresses updated\nsince this datetime (e.g. `updated_since=2017-08-01T00:00:00`)\n\nUse the param `order` to choose on which criterias the results\nshould be ordered (e.g. `order=updated_at` to order by\nupdated_at descending, use the minus operator to order\nby ascending value e.g. `order=-updated_at`).\n\nPagination information are stored in the response header as defined by RFC-5988\nhttp://tools.ietf.org/html/rfc5988\n\nExample:\n```json\n{\n\"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\\\"\",\n\"x-per-page\": \"30\",\n\"x-total\": \"10201\",\n\"x-page\": \"4\"\n}\n```\n\n"
}

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

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

Return the postal address based on its ID

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

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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?page=&per_page=&updated_since=&order=&full_profile=
Responses200

Get all 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"
          }
        }
      }
    }
  },
  "description": "\n## Return an array of users with basic information\n\nUse the param `updated_since` to fetch all users profile updated\nsince this datetime (e.g. `updated_since=2017-08-01T00:00:00`)\n\nUse the param `order` to choose on which criterias the results\nshould be ordered (e.g. `order=extended_updated_at` to order by\nextended_updated_at descending, use the minus operator to order\nby ascending value e.g. `order=-extended_updated_at`).\n\nUse the boolean `full_profile` to display the full profile of all\nusers (e.g. `full_profile=true`).\n\nPagination information are stored in the response header as defined by RFC-5988\nhttp://tools.ietf.org/html/rfc5988\n\nExample:\n```json\n{\n\"link\": \"<https://hivebrite.com/api/admin/v1/users?page=1&per_page=30>; rel=\\\"first\\\", <https://hivebrite.com/api/admin/v1/users?page=3&per_page=30>; rel=\\\"prev\\\", <https://hivebrite.com/api/admin/v1/users?page=2041&per_page=30>; rel=\\\"last\\\", <https://hivebrite.com/api/admin/v1/users?page=30&per_page=30>; rel=\\\"next\\\"\",\n\"x-per-page\": \"30\",\n\"x-total\": \"10201\",\n\"x-page\": \"4\"\n}\n```\n\n"
}

Get all users
GET/api/admin/v1/users{?page,per_page,updated_since,order,full_profile}

Return an array of users with basic information

Use the param updated_since to fetch all users profile 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=extended_updated_at to order by extended_updated_at descending, use the minus operator to order by ascending value e.g. order=-extended_updated_at).

Use the boolean full_profile to display the full profile of all users (e.g. full_profile=true).

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?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/users?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/users?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/users?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.

updated_since
string (required) 
order
string (required) 
full_profile
string (required) 

POST /api/admin/v1/users
Requests
Schema
{
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string",
          "description": "User email"
        },
        "sub_network_ids": {
          "type": "array",
          "description": "User sub networks ids",
          "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"
        },
        "firstname": {
          "type": "string",
          "description": "User first name"
        },
        "lastname": {
          "type": "string",
          "description": "User last name"
        },
        "maidenname": {
          "type": "string",
          "description": "User maiden name"
        },
        "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)"
        },
        "birthday": {
          "type": "string",
          "format": "date",
          "description": "User birth date"
        },
        "birthplace": {
          "type": "string",
          "description": "User birth place"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "User creation date time - iso8601"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "description": "User last update date time - iso8601"
        },
        "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",
          "description": "User decease date"
        },
        "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"
        },
        "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": [
                "AD",
                "AE",
                "AF",
                "AG",
                "AI",
                "AL",
                "AM",
                "AO",
                "AQ",
                "AR",
                "AS",
                "AT",
                "AU",
                "AW",
                "AX",
                "AZ",
                "BA",
                "BB",
                "BD",
                "BE",
                "BF",
                "BG",
                "BH",
                "BI",
                "BJ",
                "BL",
                "BM",
                "BN",
                "BO",
                "BQ",
                "BR",
                "BS",
                "BT",
                "BV",
                "BW",
                "BY",
                "BZ",
                "CA",
                "CC",
                "CD",
                "CF",
                "CG",
                "CH",
                "CI",
                "CK",
                "CL",
                "CM",
                "CN",
                "CO",
                "CR",
                "CU",
                "CV",
                "CW",
                "CX",
                "CY",
                "CZ",
                "DE",
                "DJ",
                "DK",
                "DM",
                "DO",
                "DZ",
                "EC",
                "EE",
                "EG",
                "EH",
                "ER",
                "ES",
                "ET",
                "FI",
                "FJ",
                "FK",
                "FM",
                "FO",
                "FR",
                "GA",
                "GB",
                "GD",
                "GE",
                "GF",
                "GG",
                "GH",
                "GI",
                "GL",
                "GM",
                "GN",
                "GP",
                "GQ",
                "GR",
                "GS",
                "GT",
                "GU",
                "GW",
                "GY",
                "HK",
                "HM",
                "HN",
                "HR",
                "HT",
                "HU",
                "ID",
                "IE",
                "IL",
                "IM",
                "IN",
                "IO",
                "IQ",
                "IR",
                "IS",
                "IT",
                "JE",
                "JM",
                "JO",
                "JP",
                "KE",
                "KG",
                "KH",
                "KI",
                "KM",
                "KN",
                "KP",
                "KR",
                "KW",
                "KY",
                "KZ",
                "LA",
                "LB",
                "LC",
                "LI",
                "LK",
                "LR",
                "LS",
                "LT",
                "LU",
                "LV",
                "LY",
                "MA",
                "MC",
                "MD",
                "ME",
                "MF",
                "MG",
                "MH",
                "MK",
                "ML",
                "MM",
                "MN",
                "MO",
                "MP",
                "MQ",
                "MR",
                "MS",
                "MT",
                "MU",
                "MV",
                "MW",
                "MX",
                "MY",
                "MZ",
                "NA",
                "NC",
                "NE",
                "NF",
                "NG",
                "NI",
                "NL",
                "NO",
                "NP",
                "NR",
                "NU",
                "NZ",
                "OM",
                "PA",
                "PE",
                "PF",
                "PG",
                "PH",
                "PK",
                "PL",
                "PM",
                "PN",
                "PR",
                "PS",
                "PT",
                "PW",
                "PY",
                "QA",
                "RE",
                "RO",
                "RS",
                "RU",
                "RW",
                "SA",
                "SB",
                "SC",
                "SD",
                "SE",
                "SG",
                "SH",
                "SI",
                "SJ",
                "SK",
                "SL",
                "SM",
                "SN",
                "SO",
                "SR",
                "SS",
                "ST",
                "SV",
                "SX",
                "SY",
                "SZ",
                "TC",
                "TD",
                "TF",
                "TG",
                "TH",
                "TJ",
                "TK",
                "TL",
                "TM",
                "TN",
                "TO",
                "TR",
                "TT",
                "TV",
                "TW",
                "TZ",
                "UA",
                "UG",
                "UM",
                "US",
                "UY",
                "UZ",
                "VA",
                "VC",
                "VE",
                "VG",
                "VI",
                "VN",
                "VU",
                "WF",
                "WS",
                "YE",
                "YT",
                "ZA",
                "ZM",
                "ZW",
                "XK"
              ],
              "description": "Country"
            },
            "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"
            },
            "user_id": {
              "type": "integer",
              "format": "int32",
              "description": "User ID linked to postal address"
            }
          }
        },
        "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": [
                "AD",
                "AE",
                "AF",
                "AG",
                "AI",
                "AL",
                "AM",
                "AO",
                "AQ",
                "AR",
                "AS",
                "AT",
                "AU",
                "AW",
                "AX",
                "AZ",
                "BA",
                "BB",
                "BD",
                "BE",
                "BF",
                "BG",
                "BH",
                "BI",
                "BJ",
                "BL",
                "BM",
                "BN",
                "BO",
                "BQ",
                "BR",
                "BS",
                "BT",
                "BV",
                "BW",
                "BY",
                "BZ",
                "CA",
                "CC",
                "CD",
                "CF",
                "CG",
                "CH",
                "CI",
                "CK",
                "CL",
                "CM",
                "CN",
                "CO",
                "CR",
                "CU",
                "CV",
                "CW",
                "CX",
                "CY",
                "CZ",
                "DE",
                "DJ",
                "DK",
                "DM",
                "DO",
                "DZ",
                "EC",
                "EE",
                "EG",
                "EH",
                "ER",
                "ES",
                "ET",
                "FI",
                "FJ",
                "FK",
                "FM",
                "FO",
                "FR",
                "GA",
                "GB",
                "GD",
                "GE",
                "GF",
                "GG",
                "GH",
                "GI",
                "GL",
                "GM",
                "GN",
                "GP",
                "GQ",
                "GR",
                "GS",
                "GT",
                "GU",
                "GW",
                "GY",
                "HK",
                "HM",
                "HN",
                "HR",
                "HT",
                "HU",
                "ID",
                "IE",
                "IL",
                "IM",
                "IN",
                "IO",
                "IQ",
                "IR",
                "IS",
                "IT",
                "JE",
                "JM",
                "JO",
                "JP",
                "KE",
                "KG",
                "KH",
                "KI",
                "KM",
                "KN",
                "KP",
                "KR",
                "KW",
                "KY",
                "KZ",
                "LA",
                "LB",
                "LC",
                "LI",
                "LK",
                "LR",
                "LS",
                "LT",
                "LU",
                "LV",
                "LY",
                "MA",
                "MC",
                "MD",
                "ME",
                "MF",
                "MG",
                "MH",
                "MK",
                "ML",
                "MM",
                "MN",
                "MO",
                "MP",
                "MQ",
                "MR",
                "MS",
                "MT",
                "MU",
                "MV",
                "MW",
                "MX",
                "MY",
                "MZ",
                "NA",
                "NC",
                "NE",
                "NF",
                "NG",
                "NI",
                "NL",
                "NO",
                "NP",
                "NR",
                "NU",
                "NZ",
                "OM",
                "PA",
                "PE",
                "PF",
                "PG",
                "PH",
                "PK",
                "PL",
                "PM",
                "PN",
                "PR",
                "PS",
                "PT",
                "PW",
                "PY",
                "QA",
                "RE",
                "RO",
                "RS",
                "RU",
                "RW",
                "SA",
                "SB",
                "SC",
                "SD",
                "SE",
                "SG",
                "SH",
                "SI",
                "SJ",
                "SK",
                "SL",
                "SM",
                "SN",
                "SO",
                "SR",
                "SS",
                "ST",
                "SV",
                "SX",
                "SY",
                "SZ",
                "TC",
                "TD",
                "TF",
                "TG",
                "TH",
                "TJ",
                "TK",
                "TL",
                "TM",
                "TN",
                "TO",
                "TR",
                "TT",
                "TV",
                "TW",
                "TZ",
                "UA",
                "UG",
                "UM",
                "US",
                "UY",
                "UZ",
                "VA",
                "VC",
                "VE",
                "VG",
                "VI",
                "VN",
                "VU",
                "WF",
                "WS",
                "YE",
                "YT",
                "ZA",
                "ZM",
                "ZW",
                "XK"
              ],
              "description": "Country"
            },
            "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"
            },
            "user_id": {
              "type": "integer",
              "format": "int32",
              "description": "User ID linked to postal address"
            }
          }
        },
        "preferred_postal_address": {
          "type": "string",
          "description": "User preferred postal address"
        },
        "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"
        },
        "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"
        },
        "facebook_profile_url": {
          "type": "string",
          "description": "User facebook profile URL"
        },
        "honorary_title": {
          "type": "string",
          "description": "User's honorary title"
        },
        "custom_attributes": {
          "type": "array",
          "description": "Array of customizable attributes with name, value and type",
          "items": {
            "type": "object"
          }
        },
        "notify_after_create": {
          "type": "string"
        }
      },
      "required": [
        "email",
        "sub_network_ids"
      ]
    }
  },
  "description": "Add a new user"
}
Responses201422

Add a new 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_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"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "User creation date time - iso8601"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "User last update date time - iso8601"
    },
    "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",
      "description": "User decease date"
    },
    "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"
    },
    "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": [
            "AD",
            "AE",
            "AF",
            "AG",
            "AI",
            "AL",
            "AM",
            "AO",
            "AQ",
            "AR",
            "AS",
            "AT",
            "AU",
            "AW",
            "AX",
            "AZ",
            "BA",
            "BB",
            "BD",
            "BE",
            "BF",
            "BG",
            "BH",
            "BI",
            "BJ",
            "BL",
            "BM",
            "BN",
            "BO",
            "BQ",
            "BR",
            "BS",
            "BT",
            "BV",
            "BW",
            "BY",
            "BZ",
            "CA",
            "CC",
            "CD",
            "CF",
            "CG",
            "CH",
            "CI",
            "CK",
            "CL",
            "CM",
            "CN",
            "CO",
            "CR",
            "CU",
            "CV",
            "CW",
            "CX",
            "CY",
            "CZ",
            "DE",
            "DJ",
            "DK",
            "DM",
            "DO",
            "DZ",
            "EC",
            "EE",
            "EG",
            "EH",
            "ER",
            "ES",
            "ET",
            "FI",
            "FJ",
            "FK",
            "FM",
            "FO",
            "FR",
            "GA",
            "GB",
            "GD",
            "GE",
            "GF",
            "GG",
            "GH",
            "GI",
            "GL",
            "GM",
            "GN",
            "GP",
            "GQ",
            "GR",
            "GS",
            "GT",
            "GU",
            "GW",
            "GY",
            "HK",
            "HM",
            "HN",
            "HR",
            "HT",
            "HU",
            "ID",
            "IE",
            "IL",
            "IM",
            "IN",
            "IO",
            "IQ",
            "IR",
            "IS",
            "IT",
            "JE",
            "JM",
            "JO",
            "JP",
            "KE",
            "KG",
            "KH",
            "KI",
            "KM",
            "KN",
            "KP",
            "KR",
            "KW",
            "KY",
            "KZ",
            "LA",
            "LB",
            "LC",
            "LI",
            "LK",
            "LR",
            "LS",
            "LT",
            "LU",
            "LV",
            "LY",
            "MA",
            "MC",
            "MD",
            "ME",
            "MF",
            "MG",
            "MH",
            "MK",
            "ML",
            "MM",
            "MN",
            "MO",
            "MP",
            "MQ",
            "MR",
            "MS",
            "MT",
            "MU",
            "MV",
            "MW",
            "MX",
            "MY",
            "MZ",
            "NA",
            "NC",
            "NE",
            "NF",
            "NG",
            "NI",
            "NL",
            "NO",
            "NP",
            "NR",
            "NU",
            "NZ",
            "OM",
            "PA",
            "PE",
            "PF",
            "PG",
            "PH",
            "PK",
            "PL",
            "PM",
            "PN",
            "PR",
            "PS",
            "PT",
            "PW",
            "PY",
            "QA",
            "RE",
            "RO",
            "RS",
            "RU",
            "RW",
            "SA",
            "SB",
            "SC",
            "SD",
            "SE",
            "SG",
            "SH",
            "SI",
            "SJ",
            "SK",
            "SL",
            "SM",
            "SN",
            "SO",
            "SR",
            "SS",
            "ST",
            "SV",
            "SX",
            "SY",
            "SZ",
            "TC",
            "TD",
            "TF",
            "TG",
            "TH",
            "TJ",
            "TK",
            "TL",
            "TM",
            "TN",
            "TO",
            "TR",
            "TT",
            "TV",
            "TW",
            "TZ",
            "UA",
            "UG",
            "UM",
            "US",
            "UY",
            "UZ",
            "VA",
            "VC",
            "VE",
            "VG",
            "VI",
            "VN",
            "VU",
            "WF",
            "WS",
            "YE",
            "YT",
            "ZA",
            "ZM",
            "ZW",
            "XK"
          ],
          "description": "Country"
        },
        "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"
        },
        "user_id": {
          "type": "integer",
          "format": "int32",
          "description": "User ID linked to postal address"
        }
      }
    },
    "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": [
            "AD",
            "AE",
            "AF",
            "AG",
            "AI",
            "AL",
            "AM",
            "AO",
            "AQ",
            "AR",
            "AS",
            "AT",
            "AU",
            "AW",
            "AX",
            "AZ",
            "BA",
            "BB",
            "BD",
            "BE",
            "BF",
            "BG",
            "BH",
            "BI",
            "BJ",
            "BL",
            "BM",
            "BN",
            "BO",
            "BQ",
            "BR",
            "BS",
            "BT",
            "BV",
            "BW",
            "BY",
            "BZ",
            "CA",
            "CC",
            "CD",
            "CF",
            "CG",
            "CH",
            "CI",
            "CK",
            "CL",
            "CM",
            "CN",
            "CO",
            "CR",
            "CU",
            "CV",
            "CW",
            "CX",
            "CY",
            "CZ",
            "DE",
            "DJ",
            "DK",
            "DM",
            "DO",
            "DZ",
            "EC",
            "EE",
            "EG",
            "EH",
            "ER",
            "ES",
            "ET",
            "FI",
            "FJ",
            "FK",
            "FM",
            "FO",
            "FR",
            "GA",
            "GB",
            "GD",
            "GE",
            "GF",
            "GG",
            "GH",
            "GI",
            "GL",
            "GM",
            "GN",
            "GP",
            "GQ",
            "GR",
            "GS",
            "GT",
            "GU",
            "GW",
            "GY",
            "HK",
            "HM",
            "HN",
            "HR",
            "HT",
            "HU",
            "ID",
            "IE",
            "IL",
            "IM",
            "IN",
            "IO",
            "IQ",
            "IR",
            "IS",
            "IT",
            "JE",
            "JM",
            "JO",
            "JP",
            "KE",
            "KG",
            "KH",
            "KI",
            "KM",
            "KN",
            "KP",
            "KR",
            "KW",
            "KY",
            "KZ",
            "LA",
            "LB",
            "LC",
            "LI",
            "LK",
            "LR",
            "LS",
            "LT",
            "LU",
            "LV",
            "LY",
            "MA",
            "MC",
            "MD",
            "ME",
            "MF",
            "MG",
            "MH",
            "MK",
            "ML",
            "MM",
            "MN",
            "MO",
            "MP",
            "MQ",
            "MR",
            "MS",
            "MT",
            "MU",
            "MV",
            "MW",
            "MX",
            "MY",
            "MZ",
            "NA",
            "NC",
            "NE",
            "NF",
            "NG",
            "NI",
            "NL",
            "NO",
            "NP",
            "NR",
            "NU",
            "NZ",
            "OM",
            "PA",
            "PE",
            "PF",
            "PG",
            "PH",
            "PK",
            "PL",
            "PM",
            "PN",
            "PR",
            "PS",
            "PT",
            "PW",
            "PY",
            "QA",
            "RE",
            "RO",
            "RS",
            "RU",
            "RW",
            "SA",
            "SB",
            "SC",
            "SD",
            "SE",
            "SG",
            "SH",
            "SI",
            "SJ",
            "SK",
            "SL",
            "SM",
            "SN",
            "SO",
            "SR",
            "SS",
            "ST",
            "SV",
            "SX",
            "SY",
            "SZ",
            "TC",
            "TD",
            "TF",
            "TG",
            "TH",
            "TJ",
            "TK",
            "TL",
            "TM",
            "TN",
            "TO",
            "TR",
            "TT",
            "TV",
            "TW",
            "TZ",
            "UA",
            "UG",
            "UM",
            "US",
            "UY",
            "UZ",
            "VA",
            "VC",
            "VE",
            "VG",
            "VI",
            "VN",
            "VU",
            "WF",
            "WS",
            "YE",
            "YT",
            "ZA",
            "ZM",
            "ZW",
            "XK"
          ],
          "description": "Country"
        },
        "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"
        },
        "user_id": {
          "type": "integer",
          "format": "int32",
          "description": "User ID linked to postal address"
        }
      }
    },
    "preferred_postal_address": {
      "type": "string",
      "enum": [
        "postal_personal",
        "postal_work"
      ],
      "description": "User preferred postal address"
    },
    "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"
    },
    "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": [
        "Pacific/Pago_Pago",
        "Pacific/Midway",
        "Pacific/Midway",
        "Pacific/Honolulu",
        "America/Juneau",
        "America/Los_Angeles",
        "America/Tijuana",
        "America/Phoenix",
        "America/Chihuahua",
        "America/Mazatlan",
        "America/Denver",
        "America/Guatemala",
        "America/Chicago",
        "America/Mexico_City",
        "America/Mexico_City",
        "America/Monterrey",
        "America/Regina",
        "America/Bogota",
        "America/New_York",
        "America/Indiana/Indianapolis",
        "America/Lima",
        "America/Lima",
        "America/Halifax",
        "America/Caracas",
        "America/Guyana",
        "America/La_Paz",
        "America/Santiago",
        "America/St_Johns",
        "America/Sao_Paulo",
        "America/Argentina/Buenos_Aires",
        "America/Godthab",
        "America/Montevideo",
        "Atlantic/South_Georgia",
        "Atlantic/Azores",
        "Atlantic/Cape_Verde",
        "Africa/Casablanca",
        "Europe/Dublin",
        "Europe/London",
        "Europe/Lisbon",
        "Europe/London",
        "Africa/Monrovia",
        "Etc/UTC",
        "Europe/Amsterdam",
        "Europe/Belgrade",
        "Europe/Berlin",
        "Europe/Berlin",
        "Europe/Bratislava",
        "Europe/Brussels",
        "Europe/Budapest",
        "Europe/Copenhagen",
        "Europe/Ljubljana",
        "Europe/Madrid",
        "Europe/Paris",
        "Europe/Prague",
        "Europe/Rome",
        "Europe/Sarajevo",
        "Europe/Skopje",
        "Europe/Stockholm",
        "Europe/Vienna",
        "Europe/Warsaw",
        "Africa/Algiers",
        "Europe/Zagreb",
        "Europe/Athens",
        "Europe/Bucharest",
        "Africa/Cairo",
        "Africa/Harare",
        "Europe/Helsinki",
        "Asia/Jerusalem",
        "Europe/Kaliningrad",
        "Europe/Kiev",
        "Africa/Johannesburg",
        "Europe/Riga",
        "Europe/Sofia",
        "Europe/Tallinn",
        "Europe/Vilnius",
        "Asia/Baghdad",
        "Europe/Istanbul",
        "Asia/Kuwait",
        "Europe/Minsk",
        "Europe/Moscow",
        "Africa/Nairobi",
        "Asia/Riyadh",
        "Europe/Moscow",
        "Europe/Volgograd",
        "Asia/Tehran",
        "Asia/Muscat",
        "Asia/Baku",
        "Asia/Muscat",
        "Europe/Samara",
        "Asia/Tbilisi",
        "Asia/Yerevan",
        "Asia/Kabul",
        "Asia/Yekaterinburg",
        "Asia/Karachi",
        "Asia/Karachi",
        "Asia/Tashkent",
        "Asia/Kolkata",
        "Asia/Kolkata",
        "Asia/Kolkata",
        "Asia/Kolkata",
        "Asia/Colombo",
        "Asia/Kathmandu",
        "Asia/Almaty",
        "Asia/Dhaka",
        "Asia/Dhaka",
        "Asia/Urumqi",
        "Asia/Rangoon",
        "Asia/Bangkok",
        "Asia/Bangkok",
        "Asia/Jakarta",
        "Asia/Krasnoyarsk",
        "Asia/Novosibirsk",
        "Asia/Shanghai",
        "Asia/Chongqing",
        "Asia/Hong_Kong",
        "Asia/Irkutsk",
        "Asia/Kuala_Lumpur",
        "Australia/Perth",
        "Asia/Singapore",
        "Asia/Taipei",
        "Asia/Ulaanbaatar",
        "Asia/Tokyo",
        "Asia/Tokyo",
        "Asia/Seoul",
        "Asia/Tokyo",
        "Asia/Yakutsk",
        "Australia/Adelaide",
        "Australia/Darwin",
        "Australia/Brisbane",
        "Australia/Melbourne",
        "Pacific/Guam",
        "Australia/Hobart",
        "Australia/Melbourne",
        "Pacific/Port_Moresby",
        "Australia/Sydney",
        "Asia/Vladivostok",
        "Asia/Magadan",
        "Pacific/Noumea",
        "Pacific/Guadalcanal",
        "Asia/Srednekolymsk",
        "Pacific/Auckland",
        "Pacific/Fiji",
        "Asia/Kamchatka",
        "Pacific/Majuro",
        "Pacific/Auckland",
        "Pacific/Chatham",
        "Pacific/Tongatapu",
        "Pacific/Apia",
        "Pacific/Fakaofo"
      ],
      "description": "User timezone"
    },
    "facebook_profile_url": {
      "type": "string",
      "description": "User facebook profile URL"
    },
    "honorary_title": {
      "type": "string",
      "enum": [
        "mr",
        "mrs",
        "ms",
        "dr",
        "prof"
      ],
      "description": "User's honorary title"
    },
    "live_location": {
      "description": "User's current location",
      "type": "object",
      "properties": {
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "Country"
        },
        "country_code": {
          "type": "string",
          "description": "ISO3166-2 Country code"
        },
        "address": {
          "type": "string",
          "description": "Address"
        },
        "lat": {
          "type": "number",
          "format": "float",
          "description": "Latitude"
        },
        "lng": {
          "type": "number",
          "format": "float",
          "description": "Longitude"
        }
      }
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Array of customizable attributes with name, value and type"
    }
  },
  "description": "## Update the user profile\n\nFind 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.\n\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

Add a new user
POST/api/admin/v1/users

Add a new user

Send invitation mail to the user

Set the params notify_after_create if you wish to automatically send an invitation to the user. Availables values to select on which email it should be sent are :

  • primary_email

  • email

  • email2

  • email1then2

  • email2then1

  • email1and2


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_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"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "User creation date time - iso8601"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "User last update date time - iso8601"
    },
    "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",
      "description": "User decease date"
    },
    "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"
    },
    "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": [
            "AD",
            "AE",
            "AF",
            "AG",
            "AI",
            "AL",
            "AM",
            "AO",
            "AQ",
            "AR",
            "AS",
            "AT",
            "AU",
            "AW",
            "AX",
            "AZ",
            "BA",
            "BB",
            "BD",
            "BE",
            "BF",
            "BG",
            "BH",
            "BI",
            "BJ",
            "BL",
            "BM",
            "BN",
            "BO",
            "BQ",
            "BR",
            "BS",
            "BT",
            "BV",
            "BW",
            "BY",
            "BZ",
            "CA",
            "CC",
            "CD",
            "CF",
            "CG",
            "CH",
            "CI",
            "CK",
            "CL",
            "CM",
            "CN",
            "CO",
            "CR",
            "CU",
            "CV",
            "CW",
            "CX",
            "CY",
            "CZ",
            "DE",
            "DJ",
            "DK",
            "DM",
            "DO",
            "DZ",
            "EC",
            "EE",
            "EG",
            "EH",
            "ER",
            "ES",
            "ET",
            "FI",
            "FJ",
            "FK",
            "FM",
            "FO",
            "FR",
            "GA",
            "GB",
            "GD",
            "GE",
            "GF",
            "GG",
            "GH",
            "GI",
            "GL",
            "GM",
            "GN",
            "GP",
            "GQ",
            "GR",
            "GS",
            "GT",
            "GU",
            "GW",
            "GY",
            "HK",
            "HM",
            "HN",
            "HR",
            "HT",
            "HU",
            "ID",
            "IE",
            "IL",
            "IM",
            "IN",
            "IO",
            "IQ",
            "IR",
            "IS",
            "IT",
            "JE",
            "JM",
            "JO",
            "JP",
            "KE",
            "KG",
            "KH",
            "KI",
            "KM",
            "KN",
            "KP",
            "KR",
            "KW",
            "KY",
            "KZ",
            "LA",
            "LB",
            "LC",
            "LI",
            "LK",
            "LR",
            "LS",
            "LT",
            "LU",
            "LV",
            "LY",
            "MA",
            "MC",
            "MD",
            "ME",
            "MF",
            "MG",
            "MH",
            "MK",
            "ML",
            "MM",
            "MN",
            "MO",
            "MP",
            "MQ",
            "MR",
            "MS",
            "MT",
            "MU",
            "MV",
            "MW",
            "MX",
            "MY",
            "MZ",
            "NA",
            "NC",
            "NE",
            "NF",
            "NG",
            "NI",
            "NL",
            "NO",
            "NP",
            "NR",
            "NU",
            "NZ",
            "OM",
            "PA",
            "PE",
            "PF",
            "PG",
            "PH",
            "PK",
            "PL",
            "PM",
            "PN",
            "PR",
            "PS",
            "PT",
            "PW",
            "PY",
            "QA",
            "RE",
            "RO",
            "RS",
            "RU",
            "RW",
            "SA",
            "SB",
            "SC",
            "SD",
            "SE",
            "SG",
            "SH",
            "SI",
            "SJ",
            "SK",
            "SL",
            "SM",
            "SN",
            "SO",
            "SR",
            "SS",
            "ST",
            "SV",
            "SX",
            "SY",
            "SZ",
            "TC",
            "TD",
            "TF",
            "TG",
            "TH",
            "TJ",
            "TK",
            "TL",
            "TM",
            "TN",
            "TO",
            "TR",
            "TT",
            "TV",
            "TW",
            "TZ",
            "UA",
            "UG",
            "UM",
            "US",
            "UY",
            "UZ",
            "VA",
            "VC",
            "VE",
            "VG",
            "VI",
            "VN",
            "VU",
            "WF",
            "WS",
            "YE",
            "YT",
            "ZA",
            "ZM",
            "ZW",
            "XK"
          ],
          "description": "Country"
        },
        "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"
        },
        "user_id": {
          "type": "integer",
          "format": "int32",
          "description": "User ID linked to postal address"
        }
      }
    },
    "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": [
            "AD",
            "AE",
            "AF",
            "AG",
            "AI",
            "AL",
            "AM",
            "AO",
            "AQ",
            "AR",
            "AS",
            "AT",
            "AU",
            "AW",
            "AX",
            "AZ",
            "BA",
            "BB",
            "BD",
            "BE",
            "BF",
            "BG",
            "BH",
            "BI",
            "BJ",
            "BL",
            "BM",
            "BN",
            "BO",
            "BQ",
            "BR",
            "BS",
            "BT",
            "BV",
            "BW",
            "BY",
            "BZ",
            "CA",
            "CC",
            "CD",
            "CF",
            "CG",
            "CH",
            "CI",
            "CK",
            "CL",
            "CM",
            "CN",
            "CO",
            "CR",
            "CU",
            "CV",
            "CW",
            "CX",
            "CY",
            "CZ",
            "DE",
            "DJ",
            "DK",
            "DM",
            "DO",
            "DZ",
            "EC",
            "EE",
            "EG",
            "EH",
            "ER",
            "ES",
            "ET",
            "FI",
            "FJ",
            "FK",
            "FM",
            "FO",
            "FR",
            "GA",
            "GB",
            "GD",
            "GE",
            "GF",
            "GG",
            "GH",
            "GI",
            "GL",
            "GM",
            "GN",
            "GP",
            "GQ",
            "GR",
            "GS",
            "GT",
            "GU",
            "GW",
            "GY",
            "HK",
            "HM",
            "HN",
            "HR",
            "HT",
            "HU",
            "ID",
            "IE",
            "IL",
            "IM",
            "IN",
            "IO",
            "IQ",
            "IR",
            "IS",
            "IT",
            "JE",
            "JM",
            "JO",
            "JP",
            "KE",
            "KG",
            "KH",
            "KI",
            "KM",
            "KN",
            "KP",
            "KR",
            "KW",
            "KY",
            "KZ",
            "LA",
            "LB",
            "LC",
            "LI",
            "LK",
            "LR",
            "LS",
            "LT",
            "LU",
            "LV",
            "LY",
            "MA",
            "MC",
            "MD",
            "ME",
            "MF",
            "MG",
            "MH",
            "MK",
            "ML",
            "MM",
            "MN",
            "MO",
            "MP",
            "MQ",
            "MR",
            "MS",
            "MT",
            "MU",
            "MV",
            "MW",
            "MX",
            "MY",
            "MZ",
            "NA",
            "NC",
            "NE",
            "NF",
            "NG",
            "NI",
            "NL",
            "NO",
            "NP",
            "NR",
            "NU",
            "NZ",
            "OM",
            "PA",
            "PE",
            "PF",
            "PG",
            "PH",
            "PK",
            "PL",
            "PM",
            "PN",
            "PR",
            "PS",
            "PT",
            "PW",
            "PY",
            "QA",
            "RE",
            "RO",
            "RS",
            "RU",
            "RW",
            "SA",
            "SB",
            "SC",
            "SD",
            "SE",
            "SG",
            "SH",
            "SI",
            "SJ",
            "SK",
            "SL",
            "SM",
            "SN",
            "SO",
            "SR",
            "SS",
            "ST",
            "SV",
            "SX",
            "SY",
            "SZ",
            "TC",
            "TD",
            "TF",
            "TG",
            "TH",
            "TJ",
            "TK",
            "TL",
            "TM",
            "TN",
            "TO",
            "TR",
            "TT",
            "TV",
            "TW",
            "TZ",
            "UA",
            "UG",
            "UM",
            "US",
            "UY",
            "UZ",
            "VA",
            "VC",
            "VE",
            "VG",
            "VI",
            "VN",
            "VU",
            "WF",
            "WS",
            "YE",
            "YT",
            "ZA",
            "ZM",
            "ZW",
            "XK"
          ],
          "description": "Country"
        },
        "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"
        },
        "user_id": {
          "type": "integer",
          "format": "int32",
          "description": "User ID linked to postal address"
        }
      }
    },
    "preferred_postal_address": {
      "type": "string",
      "enum": [
        "postal_personal",
        "postal_work"
      ],
      "description": "User preferred postal address"
    },
    "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"
    },
    "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": [
        "Pacific/Pago_Pago",
        "Pacific/Midway",
        "Pacific/Midway",
        "Pacific/Honolulu",
        "America/Juneau",
        "America/Los_Angeles",
        "America/Tijuana",
        "America/Phoenix",
        "America/Chihuahua",
        "America/Mazatlan",
        "America/Denver",
        "America/Guatemala",
        "America/Chicago",
        "America/Mexico_City",
        "America/Mexico_City",
        "America/Monterrey",
        "America/Regina",
        "America/Bogota",
        "America/New_York",
        "America/Indiana/Indianapolis",
        "America/Lima",
        "America/Lima",
        "America/Halifax",
        "America/Caracas",
        "America/Guyana",
        "America/La_Paz",
        "America/Santiago",
        "America/St_Johns",
        "America/Sao_Paulo",
        "America/Argentina/Buenos_Aires",
        "America/Godthab",
        "America/Montevideo",
        "Atlantic/South_Georgia",
        "Atlantic/Azores",
        "Atlantic/Cape_Verde",
        "Africa/Casablanca",
        "Europe/Dublin",
        "Europe/London",
        "Europe/Lisbon",
        "Europe/London",
        "Africa/Monrovia",
        "Etc/UTC",
        "Europe/Amsterdam",
        "Europe/Belgrade",
        "Europe/Berlin",
        "Europe/Berlin",
        "Europe/Bratislava",
        "Europe/Brussels",
        "Europe/Budapest",
        "Europe/Copenhagen",
        "Europe/Ljubljana",
        "Europe/Madrid",
        "Europe/Paris",
        "Europe/Prague",
        "Europe/Rome",
        "Europe/Sarajevo",
        "Europe/Skopje",
        "Europe/Stockholm",
        "Europe/Vienna",
        "Europe/Warsaw",
        "Africa/Algiers",
        "Europe/Zagreb",
        "Europe/Athens",
        "Europe/Bucharest",
        "Africa/Cairo",
        "Africa/Harare",
        "Europe/Helsinki",
        "Asia/Jerusalem",
        "Europe/Kaliningrad",
        "Europe/Kiev",
        "Africa/Johannesburg",
        "Europe/Riga",
        "Europe/Sofia",
        "Europe/Tallinn",
        "Europe/Vilnius",
        "Asia/Baghdad",
        "Europe/Istanbul",
        "Asia/Kuwait",
        "Europe/Minsk",
        "Europe/Moscow",
        "Africa/Nairobi",
        "Asia/Riyadh",
        "Europe/Moscow",
        "Europe/Volgograd",
        "Asia/Tehran",
        "Asia/Muscat",
        "Asia/Baku",
        "Asia/Muscat",
        "Europe/Samara",
        "Asia/Tbilisi",
        "Asia/Yerevan",
        "Asia/Kabul",
        "Asia/Yekaterinburg",
        "Asia/Karachi",
        "Asia/Karachi",
        "Asia/Tashkent",
        "Asia/Kolkata",
        "Asia/Kolkata",
        "Asia/Kolkata",
        "Asia/Kolkata",
        "Asia/Colombo",
        "Asia/Kathmandu",
        "Asia/Almaty",
        "Asia/Dhaka",
        "Asia/Dhaka",
        "Asia/Urumqi",
        "Asia/Rangoon",
        "Asia/Bangkok",
        "Asia/Bangkok",
        "Asia/Jakarta",
        "Asia/Krasnoyarsk",
        "Asia/Novosibirsk",
        "Asia/Shanghai",
        "Asia/Chongqing",
        "Asia/Hong_Kong",
        "Asia/Irkutsk",
        "Asia/Kuala_Lumpur",
        "Australia/Perth",
        "Asia/Singapore",
        "Asia/Taipei",
        "Asia/Ulaanbaatar",
        "Asia/Tokyo",
        "Asia/Tokyo",
        "Asia/Seoul",
        "Asia/Tokyo",
        "Asia/Yakutsk",
        "Australia/Adelaide",
        "Australia/Darwin",
        "Australia/Brisbane",
        "Australia/Melbourne",
        "Pacific/Guam",
        "Australia/Hobart",
        "Australia/Melbourne",
        "Pacific/Port_Moresby",
        "Australia/Sydney",
        "Asia/Vladivostok",
        "Asia/Magadan",
        "Pacific/Noumea",
        "Pacific/Guadalcanal",
        "Asia/Srednekolymsk",
        "Pacific/Auckland",
        "Pacific/Fiji",
        "Asia/Kamchatka",
        "Pacific/Majuro",
        "Pacific/Auckland",
        "Pacific/Chatham",
        "Pacific/Tongatapu",
        "Pacific/Apia",
        "Pacific/Fakaofo"
      ],
      "description": "User timezone"
    },
    "facebook_profile_url": {
      "type": "string",
      "description": "User facebook profile URL"
    },
    "honorary_title": {
      "type": "string",
      "enum": [
        "mr",
        "mrs",
        "ms",
        "dr",
        "prof"
      ],
      "description": "User's honorary title"
    },
    "live_location": {
      "description": "User's current location",
      "type": "object",
      "properties": {
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "Country"
        },
        "country_code": {
          "type": "string",
          "description": "ISO3166-2 Country code"
        },
        "address": {
          "type": "string",
          "description": "Address"
        },
        "lat": {
          "type": "number",
          "format": "float",
          "description": "Latitude"
        },
        "lng": {
          "type": "number",
          "format": "float",
          "description": "Longitude"
        }
      }
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Array of customizable attributes with name, value and type"
    }
  },
  "description": "## Update the user profile\n\nFind 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.\n\n"
}

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/id
Requests
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "user": {
      "type": "object",
      "properties": {
        "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"
        },
        "firstname": {
          "type": "string",
          "description": "User first name"
        },
        "lastname": {
          "type": "string",
          "description": "User last name"
        },
        "maidenname": {
          "type": "string",
          "description": "User maiden name"
        },
        "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)"
        },
        "birthday": {
          "type": "string",
          "format": "date",
          "description": "User birth date"
        },
        "birthplace": {
          "type": "string",
          "description": "User birth place"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "User creation date time - iso8601"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "description": "User last update date time - iso8601"
        },
        "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",
          "description": "User decease date"
        },
        "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"
        },
        "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": [
                "AD",
                "AE",
                "AF",
                "AG",
                "AI",
                "AL",
                "AM",
                "AO",
                "AQ",
                "AR",
                "AS",
                "AT",
                "AU",
                "AW",
                "AX",
                "AZ",
                "BA",
                "BB",
                "BD",
                "BE",
                "BF",
                "BG",
                "BH",
                "BI",
                "BJ",
                "BL",
                "BM",
                "BN",
                "BO",
                "BQ",
                "BR",
                "BS",
                "BT",
                "BV",
                "BW",
                "BY",
                "BZ",
                "CA",
                "CC",
                "CD",
                "CF",
                "CG",
                "CH",
                "CI",
                "CK",
                "CL",
                "CM",
                "CN",
                "CO",
                "CR",
                "CU",
                "CV",
                "CW",
                "CX",
                "CY",
                "CZ",
                "DE",
                "DJ",
                "DK",
                "DM",
                "DO",
                "DZ",
                "EC",
                "EE",
                "EG",
                "EH",
                "ER",
                "ES",
                "ET",
                "FI",
                "FJ",
                "FK",
                "FM",
                "FO",
                "FR",
                "GA",
                "GB",
                "GD",
                "GE",
                "GF",
                "GG",
                "GH",
                "GI",
                "GL",
                "GM",
                "GN",
                "GP",
                "GQ",
                "GR",
                "GS",
                "GT",
                "GU",
                "GW",
                "GY",
                "HK",
                "HM",
                "HN",
                "HR",
                "HT",
                "HU",
                "ID",
                "IE",
                "IL",
                "IM",
                "IN",
                "IO",
                "IQ",
                "IR",
                "IS",
                "IT",
                "JE",
                "JM",
                "JO",
                "JP",
                "KE",
                "KG",
                "KH",
                "KI",
                "KM",
                "KN",
                "KP",
                "KR",
                "KW",
                "KY",
                "KZ",
                "LA",
                "LB",
                "LC",
                "LI",
                "LK",
                "LR",
                "LS",
                "LT",
                "LU",
                "LV",
                "LY",
                "MA",
                "MC",
                "MD",
                "ME",
                "MF",
                "MG",
                "MH",
                "MK",
                "ML",
                "MM",
                "MN",
                "MO",
                "MP",
                "MQ",
                "MR",
                "MS",
                "MT",
                "MU",
                "MV",
                "MW",
                "MX",
                "MY",
                "MZ",
                "NA",
                "NC",
                "NE",
                "NF",
                "NG",
                "NI",
                "NL",
                "NO",
                "NP",
                "NR",
                "NU",
                "NZ",
                "OM",
                "PA",
                "PE",
                "PF",
                "PG",
                "PH",
                "PK",
                "PL",
                "PM",
                "PN",
                "PR",
                "PS",
                "PT",
                "PW",
                "PY",
                "QA",
                "RE",
                "RO",
                "RS",
                "RU",
                "RW",
                "SA",
                "SB",
                "SC",
                "SD",
                "SE",
                "SG",
                "SH",
                "SI",
                "SJ",
                "SK",
                "SL",
                "SM",
                "SN",
                "SO",
                "SR",
                "SS",
                "ST",
                "SV",
                "SX",
                "SY",
                "SZ",
                "TC",
                "TD",
                "TF",
                "TG",
                "TH",
                "TJ",
                "TK",
                "TL",
                "TM",
                "TN",
                "TO",
                "TR",
                "TT",
                "TV",
                "TW",
                "TZ",
                "UA",
                "UG",
                "UM",
                "US",
                "UY",
                "UZ",
                "VA",
                "VC",
                "VE",
                "VG",
                "VI",
                "VN",
                "VU",
                "WF",
                "WS",
                "YE",
                "YT",
                "ZA",
                "ZM",
                "ZW",
                "XK"
              ],
              "description": "Country"
            },
            "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"
            },
            "user_id": {
              "type": "integer",
              "format": "int32",
              "description": "User ID linked to postal address"
            }
          }
        },
        "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": [
                "AD",
                "AE",
                "AF",
                "AG",
                "AI",
                "AL",
                "AM",
                "AO",
                "AQ",
                "AR",
                "AS",
                "AT",
                "AU",
                "AW",
                "AX",
                "AZ",
                "BA",
                "BB",
                "BD",
                "BE",
                "BF",
                "BG",
                "BH",
                "BI",
                "BJ",
                "BL",
                "BM",
                "BN",
                "BO",
                "BQ",
                "BR",
                "BS",
                "BT",
                "BV",
                "BW",
                "BY",
                "BZ",
                "CA",
                "CC",
                "CD",
                "CF",
                "CG",
                "CH",
                "CI",
                "CK",
                "CL",
                "CM",
                "CN",
                "CO",
                "CR",
                "CU",
                "CV",
                "CW",
                "CX",
                "CY",
                "CZ",
                "DE",
                "DJ",
                "DK",
                "DM",
                "DO",
                "DZ",
                "EC",
                "EE",
                "EG",
                "EH",
                "ER",
                "ES",
                "ET",
                "FI",
                "FJ",
                "FK",
                "FM",
                "FO",
                "FR",
                "GA",
                "GB",
                "GD",
                "GE",
                "GF",
                "GG",
                "GH",
                "GI",
                "GL",
                "GM",
                "GN",
                "GP",
                "GQ",
                "GR",
                "GS",
                "GT",
                "GU",
                "GW",
                "GY",
                "HK",
                "HM",
                "HN",
                "HR",
                "HT",
                "HU",
                "ID",
                "IE",
                "IL",
                "IM",
                "IN",
                "IO",
                "IQ",
                "IR",
                "IS",
                "IT",
                "JE",
                "JM",
                "JO",
                "JP",
                "KE",
                "KG",
                "KH",
                "KI",
                "KM",
                "KN",
                "KP",
                "KR",
                "KW",
                "KY",
                "KZ",
                "LA",
                "LB",
                "LC",
                "LI",
                "LK",
                "LR",
                "LS",
                "LT",
                "LU",
                "LV",
                "LY",
                "MA",
                "MC",
                "MD",
                "ME",
                "MF",
                "MG",
                "MH",
                "MK",
                "ML",
                "MM",
                "MN",
                "MO",
                "MP",
                "MQ",
                "MR",
                "MS",
                "MT",
                "MU",
                "MV",
                "MW",
                "MX",
                "MY",
                "MZ",
                "NA",
                "NC",
                "NE",
                "NF",
                "NG",
                "NI",
                "NL",
                "NO",
                "NP",
                "NR",
                "NU",
                "NZ",
                "OM",
                "PA",
                "PE",
                "PF",
                "PG",
                "PH",
                "PK",
                "PL",
                "PM",
                "PN",
                "PR",
                "PS",
                "PT",
                "PW",
                "PY",
                "QA",
                "RE",
                "RO",
                "RS",
                "RU",
                "RW",
                "SA",
                "SB",
                "SC",
                "SD",
                "SE",
                "SG",
                "SH",
                "SI",
                "SJ",
                "SK",
                "SL",
                "SM",
                "SN",
                "SO",
                "SR",
                "SS",
                "ST",
                "SV",
                "SX",
                "SY",
                "SZ",
                "TC",
                "TD",
                "TF",
                "TG",
                "TH",
                "TJ",
                "TK",
                "TL",
                "TM",
                "TN",
                "TO",
                "TR",
                "TT",
                "TV",
                "TW",
                "TZ",
                "UA",
                "UG",
                "UM",
                "US",
                "UY",
                "UZ",
                "VA",
                "VC",
                "VE",
                "VG",
                "VI",
                "VN",
                "VU",
                "WF",
                "WS",
                "YE",
                "YT",
                "ZA",
                "ZM",
                "ZW",
                "XK"
              ],
              "description": "Country"
            },
            "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"
            },
            "user_id": {
              "type": "integer",
              "format": "int32",
              "description": "User ID linked to postal address"
            }
          }
        },
        "preferred_postal_address": {
          "type": "string",
          "description": "User preferred postal address"
        },
        "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"
        },
        "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"
        },
        "facebook_profile_url": {
          "type": "string",
          "description": "User facebook profile URL"
        },
        "honorary_title": {
          "type": "string",
          "description": "User's honorary title"
        },
        "custom_attributes": {
          "type": "array",
          "description": "Array of customizable attributes with name, value and type",
          "items": {
            "type": "object"
          }
        }
      }
    }
  },
  "description": "Update existing user"
}
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_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"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "User creation date time - iso8601"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "User last update date time - iso8601"
    },
    "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",
      "description": "User decease date"
    },
    "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"
    },
    "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": [
            "AD",
            "AE",
            "AF",
            "AG",
            "AI",
            "AL",
            "AM",
            "AO",
            "AQ",
            "AR",
            "AS",
            "AT",
            "AU",
            "AW",
            "AX",
            "AZ",
            "BA",
            "BB",
            "BD",
            "BE",
            "BF",
            "BG",
            "BH",
            "BI",
            "BJ",
            "BL",
            "BM",
            "BN",
            "BO",
            "BQ",
            "BR",
            "BS",
            "BT",
            "BV",
            "BW",
            "BY",
            "BZ",
            "CA",
            "CC",
            "CD",
            "CF",
            "CG",
            "CH",
            "CI",
            "CK",
            "CL",
            "CM",
            "CN",
            "CO",
            "CR",
            "CU",
            "CV",
            "CW",
            "CX",
            "CY",
            "CZ",
            "DE",
            "DJ",
            "DK",
            "DM",
            "DO",
            "DZ",
            "EC",
            "EE",
            "EG",
            "EH",
            "ER",
            "ES",
            "ET",
            "FI",
            "FJ",
            "FK",
            "FM",
            "FO",
            "FR",
            "GA",
            "GB",
            "GD",
            "GE",
            "GF",
            "GG",
            "GH",
            "GI",
            "GL",
            "GM",
            "GN",
            "GP",
            "GQ",
            "GR",
            "GS",
            "GT",
            "GU",
            "GW",
            "GY",
            "HK",
            "HM",
            "HN",
            "HR",
            "HT",
            "HU",
            "ID",
            "IE",
            "IL",
            "IM",
            "IN",
            "IO",
            "IQ",
            "IR",
            "IS",
            "IT",
            "JE",
            "JM",
            "JO",
            "JP",
            "KE",
            "KG",
            "KH",
            "KI",
            "KM",
            "KN",
            "KP",
            "KR",
            "KW",
            "KY",
            "KZ",
            "LA",
            "LB",
            "LC",
            "LI",
            "LK",
            "LR",
            "LS",
            "LT",
            "LU",
            "LV",
            "LY",
            "MA",
            "MC",
            "MD",
            "ME",
            "MF",
            "MG",
            "MH",
            "MK",
            "ML",
            "MM",
            "MN",
            "MO",
            "MP",
            "MQ",
            "MR",
            "MS",
            "MT",
            "MU",
            "MV",
            "MW",
            "MX",
            "MY",
            "MZ",
            "NA",
            "NC",
            "NE",
            "NF",
            "NG",
            "NI",
            "NL",
            "NO",
            "NP",
            "NR",
            "NU",
            "NZ",
            "OM",
            "PA",
            "PE",
            "PF",
            "PG",
            "PH",
            "PK",
            "PL",
            "PM",
            "PN",
            "PR",
            "PS",
            "PT",
            "PW",
            "PY",
            "QA",
            "RE",
            "RO",
            "RS",
            "RU",
            "RW",
            "SA",
            "SB",
            "SC",
            "SD",
            "SE",
            "SG",
            "SH",
            "SI",
            "SJ",
            "SK",
            "SL",
            "SM",
            "SN",
            "SO",
            "SR",
            "SS",
            "ST",
            "SV",
            "SX",
            "SY",
            "SZ",
            "TC",
            "TD",
            "TF",
            "TG",
            "TH",
            "TJ",
            "TK",
            "TL",
            "TM",
            "TN",
            "TO",
            "TR",
            "TT",
            "TV",
            "TW",
            "TZ",
            "UA",
            "UG",
            "UM",
            "US",
            "UY",
            "UZ",
            "VA",
            "VC",
            "VE",
            "VG",
            "VI",
            "VN",
            "VU",
            "WF",
            "WS",
            "YE",
            "YT",
            "ZA",
            "ZM",
            "ZW",
            "XK"
          ],
          "description": "Country"
        },
        "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"
        },
        "user_id": {
          "type": "integer",
          "format": "int32",
          "description": "User ID linked to postal address"
        }
      }
    },
    "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": [
            "AD",
            "AE",
            "AF",
            "AG",
            "AI",
            "AL",
            "AM",
            "AO",
            "AQ",
            "AR",
            "AS",
            "AT",
            "AU",
            "AW",
            "AX",
            "AZ",
            "BA",
            "BB",
            "BD",
            "BE",
            "BF",
            "BG",
            "BH",
            "BI",
            "BJ",
            "BL",
            "BM",
            "BN",
            "BO",
            "BQ",
            "BR",
            "BS",
            "BT",
            "BV",
            "BW",
            "BY",
            "BZ",
            "CA",
            "CC",
            "CD",
            "CF",
            "CG",
            "CH",
            "CI",
            "CK",
            "CL",
            "CM",
            "CN",
            "CO",
            "CR",
            "CU",
            "CV",
            "CW",
            "CX",
            "CY",
            "CZ",
            "DE",
            "DJ",
            "DK",
            "DM",
            "DO",
            "DZ",
            "EC",
            "EE",
            "EG",
            "EH",
            "ER",
            "ES",
            "ET",
            "FI",
            "FJ",
            "FK",
            "FM",
            "FO",
            "FR",
            "GA",
            "GB",
            "GD",
            "GE",
            "GF",
            "GG",
            "GH",
            "GI",
            "GL",
            "GM",
            "GN",
            "GP",
            "GQ",
            "GR",
            "GS",
            "GT",
            "GU",
            "GW",
            "GY",
            "HK",
            "HM",
            "HN",
            "HR",
            "HT",
            "HU",
            "ID",
            "IE",
            "IL",
            "IM",
            "IN",
            "IO",
            "IQ",
            "IR",
            "IS",
            "IT",
            "JE",
            "JM",
            "JO",
            "JP",
            "KE",
            "KG",
            "KH",
            "KI",
            "KM",
            "KN",
            "KP",
            "KR",
            "KW",
            "KY",
            "KZ",
            "LA",
            "LB",
            "LC",
            "LI",
            "LK",
            "LR",
            "LS",
            "LT",
            "LU",
            "LV",
            "LY",
            "MA",
            "MC",
            "MD",
            "ME",
            "MF",
            "MG",
            "MH",
            "MK",
            "ML",
            "MM",
            "MN",
            "MO",
            "MP",
            "MQ",
            "MR",
            "MS",
            "MT",
            "MU",
            "MV",
            "MW",
            "MX",
            "MY",
            "MZ",
            "NA",
            "NC",
            "NE",
            "NF",
            "NG",
            "NI",
            "NL",
            "NO",
            "NP",
            "NR",
            "NU",
            "NZ",
            "OM",
            "PA",
            "PE",
            "PF",
            "PG",
            "PH",
            "PK",
            "PL",
            "PM",
            "PN",
            "PR",
            "PS",
            "PT",
            "PW",
            "PY",
            "QA",
            "RE",
            "RO",
            "RS",
            "RU",
            "RW",
            "SA",
            "SB",
            "SC",
            "SD",
            "SE",
            "SG",
            "SH",
            "SI",
            "SJ",
            "SK",
            "SL",
            "SM",
            "SN",
            "SO",
            "SR",
            "SS",
            "ST",
            "SV",
            "SX",
            "SY",
            "SZ",
            "TC",
            "TD",
            "TF",
            "TG",
            "TH",
            "TJ",
            "TK",
            "TL",
            "TM",
            "TN",
            "TO",
            "TR",
            "TT",
            "TV",
            "TW",
            "TZ",
            "UA",
            "UG",
            "UM",
            "US",
            "UY",
            "UZ",
            "VA",
            "VC",
            "VE",
            "VG",
            "VI",
            "VN",
            "VU",
            "WF",
            "WS",
            "YE",
            "YT",
            "ZA",
            "ZM",
            "ZW",
            "XK"
          ],
          "description": "Country"
        },
        "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"
        },
        "user_id": {
          "type": "integer",
          "format": "int32",
          "description": "User ID linked to postal address"
        }
      }
    },
    "preferred_postal_address": {
      "type": "string",
      "enum": [
        "postal_personal",
        "postal_work"
      ],
      "description": "User preferred postal address"
    },
    "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"
    },
    "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": [
        "Pacific/Pago_Pago",
        "Pacific/Midway",
        "Pacific/Midway",
        "Pacific/Honolulu",
        "America/Juneau",
        "America/Los_Angeles",
        "America/Tijuana",
        "America/Phoenix",
        "America/Chihuahua",
        "America/Mazatlan",
        "America/Denver",
        "America/Guatemala",
        "America/Chicago",
        "America/Mexico_City",
        "America/Mexico_City",
        "America/Monterrey",
        "America/Regina",
        "America/Bogota",
        "America/New_York",
        "America/Indiana/Indianapolis",
        "America/Lima",
        "America/Lima",
        "America/Halifax",
        "America/Caracas",
        "America/Guyana",
        "America/La_Paz",
        "America/Santiago",
        "America/St_Johns",
        "America/Sao_Paulo",
        "America/Argentina/Buenos_Aires",
        "America/Godthab",
        "America/Montevideo",
        "Atlantic/South_Georgia",
        "Atlantic/Azores",
        "Atlantic/Cape_Verde",
        "Africa/Casablanca",
        "Europe/Dublin",
        "Europe/London",
        "Europe/Lisbon",
        "Europe/London",
        "Africa/Monrovia",
        "Etc/UTC",
        "Europe/Amsterdam",
        "Europe/Belgrade",
        "Europe/Berlin",
        "Europe/Berlin",
        "Europe/Bratislava",
        "Europe/Brussels",
        "Europe/Budapest",
        "Europe/Copenhagen",
        "Europe/Ljubljana",
        "Europe/Madrid",
        "Europe/Paris",
        "Europe/Prague",
        "Europe/Rome",
        "Europe/Sarajevo",
        "Europe/Skopje",
        "Europe/Stockholm",
        "Europe/Vienna",
        "Europe/Warsaw",
        "Africa/Algiers",
        "Europe/Zagreb",
        "Europe/Athens",
        "Europe/Bucharest",
        "Africa/Cairo",
        "Africa/Harare",
        "Europe/Helsinki",
        "Asia/Jerusalem",
        "Europe/Kaliningrad",
        "Europe/Kiev",
        "Africa/Johannesburg",
        "Europe/Riga",
        "Europe/Sofia",
        "Europe/Tallinn",
        "Europe/Vilnius",
        "Asia/Baghdad",
        "Europe/Istanbul",
        "Asia/Kuwait",
        "Europe/Minsk",
        "Europe/Moscow",
        "Africa/Nairobi",
        "Asia/Riyadh",
        "Europe/Moscow",
        "Europe/Volgograd",
        "Asia/Tehran",
        "Asia/Muscat",
        "Asia/Baku",
        "Asia/Muscat",
        "Europe/Samara",
        "Asia/Tbilisi",
        "Asia/Yerevan",
        "Asia/Kabul",
        "Asia/Yekaterinburg",
        "Asia/Karachi",
        "Asia/Karachi",
        "Asia/Tashkent",
        "Asia/Kolkata",
        "Asia/Kolkata",
        "Asia/Kolkata",
        "Asia/Kolkata",
        "Asia/Colombo",
        "Asia/Kathmandu",
        "Asia/Almaty",
        "Asia/Dhaka",
        "Asia/Dhaka",
        "Asia/Urumqi",
        "Asia/Rangoon",
        "Asia/Bangkok",
        "Asia/Bangkok",
        "Asia/Jakarta",
        "Asia/Krasnoyarsk",
        "Asia/Novosibirsk",
        "Asia/Shanghai",
        "Asia/Chongqing",
        "Asia/Hong_Kong",
        "Asia/Irkutsk",
        "Asia/Kuala_Lumpur",
        "Australia/Perth",
        "Asia/Singapore",
        "Asia/Taipei",
        "Asia/Ulaanbaatar",
        "Asia/Tokyo",
        "Asia/Tokyo",
        "Asia/Seoul",
        "Asia/Tokyo",
        "Asia/Yakutsk",
        "Australia/Adelaide",
        "Australia/Darwin",
        "Australia/Brisbane",
        "Australia/Melbourne",
        "Pacific/Guam",
        "Australia/Hobart",
        "Australia/Melbourne",
        "Pacific/Port_Moresby",
        "Australia/Sydney",
        "Asia/Vladivostok",
        "Asia/Magadan",
        "Pacific/Noumea",
        "Pacific/Guadalcanal",
        "Asia/Srednekolymsk",
        "Pacific/Auckland",
        "Pacific/Fiji",
        "Asia/Kamchatka",
        "Pacific/Majuro",
        "Pacific/Auckland",
        "Pacific/Chatham",
        "Pacific/Tongatapu",
        "Pacific/Apia",
        "Pacific/Fakaofo"
      ],
      "description": "User timezone"
    },
    "facebook_profile_url": {
      "type": "string",
      "description": "User facebook profile URL"
    },
    "honorary_title": {
      "type": "string",
      "enum": [
        "mr",
        "mrs",
        "ms",
        "dr",
        "prof"
      ],
      "description": "User's honorary title"
    },
    "live_location": {
      "description": "User's current location",
      "type": "object",
      "properties": {
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "Country"
        },
        "country_code": {
          "type": "string",
          "description": "ISO3166-2 Country code"
        },
        "address": {
          "type": "string",
          "description": "Address"
        },
        "lat": {
          "type": "number",
          "format": "float",
          "description": "Latitude"
        },
        "lng": {
          "type": "number",
          "format": "float",
          "description": "Longitude"
        }
      }
    },
    "custom_attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Array of customizable attributes with name, value and type"
    }
  },
  "description": "## Update the user profile\n\nFind 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.\n\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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.

URI Parameters
id
string (required) 

User ID


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) 

POST /api/admin/v1/users/_bulk
Requests
Schema
{
  "type": "object",
  "properties": {
    "users": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string",
          "description": "User email"
        },
        "sub_network_ids": {
          "type": "array",
          "description": "User sub networks ids",
          "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"
        },
        "firstname": {
          "type": "string",
          "description": "User first name"
        },
        "lastname": {
          "type": "string",
          "description": "User last name"
        },
        "maidenname": {
          "type": "string",
          "description": "User maiden name"
        },
        "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)"
        },
        "birthday": {
          "type": "string",
          "format": "date",
          "description": "User birth date"
        },
        "birthplace": {
          "type": "string",
          "description": "User birth place"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "User creation date time - iso8601"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "description": "User last update date time - iso8601"
        },
        "citizenship_ids": {
          "type": "array",
          "description": "List of citizenship IDs",
          "items": {
            "type": "string",
            "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",
          "description": "User decease date"
        },
        "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"
        },
        "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": [
                "AD",
                "AE",
                "AF",
                "AG",
                "AI",
                "AL",
                "AM",
                "AO",
                "AQ",
                "AR",
                "AS",
                "AT",
                "AU",
                "AW",
                "AX",
                "AZ",
                "BA",
                "BB",
                "BD",
                "BE",
                "BF",
                "BG",
                "BH",
                "BI",
                "BJ",
                "BL",
                "BM",
                "BN",
                "BO",
                "BQ",
                "BR",
                "BS",
                "BT",
                "BV",
                "BW",
                "BY",
                "BZ",
                "CA",
                "CC",
                "CD",
                "CF",
                "CG",
                "CH",
                "CI",
                "CK",
                "CL",
                "CM",
                "CN",
                "CO",
                "CR",
                "CU",
                "CV",
                "CW",
                "CX",
                "CY",
                "CZ",
                "DE",
                "DJ",
                "DK",
                "DM",
                "DO",
                "DZ",
                "EC",
                "EE",
                "EG",
                "EH",
                "ER",
                "ES",
                "ET",
                "FI",
                "FJ",
                "FK",
                "FM",
                "FO",
                "FR",
                "GA",
                "GB",
                "GD",
                "GE",
                "GF",
                "GG",
                "GH",
                "GI",
                "GL",
                "GM",
                "GN",
                "GP",
                "GQ",
                "GR",
                "GS",
                "GT",
                "GU",
                "GW",
                "GY",
                "HK",
                "HM",
                "HN",
                "HR",
                "HT",
                "HU",
                "ID",
                "IE",
                "IL",
                "IM",
                "IN",
                "IO",
                "IQ",
                "IR",
                "IS",
                "IT",
                "JE",
                "JM",
                "JO",
                "JP",
                "KE",
                "KG",
                "KH",
                "KI",
                "KM",
                "KN",
                "KP",
                "KR",
                "KW",
                "KY",
                "KZ",
                "LA",
                "LB",
                "LC",
                "LI",
                "LK",
                "LR",
                "LS",
                "LT",
                "LU",
                "LV",
                "LY",
                "MA",
                "MC",
                "MD",
                "ME",
                "MF",
                "MG",
                "MH",
                "MK",
                "ML",
                "MM",
                "MN",
                "MO",
                "MP",
                "MQ",
                "MR",
                "MS",
                "MT",
                "MU",
                "MV",
                "MW",
                "MX",
                "MY",
                "MZ",
                "NA",
                "NC",
                "NE",
                "NF",
                "NG",
                "NI",
                "NL",
                "NO",
                "NP",
                "NR",
                "NU",
                "NZ",
                "OM",
                "PA",
                "PE",
                "PF",
                "PG",
                "PH",
                "PK",
                "PL",
                "PM",
                "PN",
                "PR",
                "PS",
                "PT",
                "PW",
                "PY",
                "QA",
                "RE",
                "RO",
                "RS",
                "RU",
                "RW",
                "SA",
                "SB",
                "SC",
                "SD",
                "SE",
                "SG",
                "SH",
                "SI",
                "SJ",
                "SK",
                "SL",
                "SM",
                "SN",
                "SO",
                "SR",
                "SS",
                "ST",
                "SV",
                "SX",
                "SY",
                "SZ",
                "TC",
                "TD",
                "TF",
                "TG",
                "TH",
                "TJ",
                "TK",
                "TL",
                "TM",
                "TN",
                "TO",
                "TR",
                "TT",
                "TV",
                "TW",
                "TZ",
                "UA",
                "UG",
                "UM",
                "US",
                "UY",
                "UZ",
                "VA",
                "VC",
                "VE",
                "VG",
                "VI",
                "VN",
                "VU",
                "WF",
                "WS",
                "YE",
                "YT",
                "ZA",
                "ZM",
                "ZW",
                "XK"
              ],
              "description": "Country"
            },
            "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"
            },
            "user_id": {
              "type": "integer",
              "format": "int32",
              "description": "User ID linked to postal address"
            }
          }
        },
        "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": [
                "AD",
                "AE",
                "AF",
                "AG",
                "AI",
                "AL",
                "AM",
                "AO",
                "AQ",
                "AR",
                "AS",
                "AT",
                "AU",
                "AW",
                "AX",
                "AZ",
                "BA",
                "BB",
                "BD",
                "BE",
                "BF",
                "BG",
                "BH",
                "BI",
                "BJ",
                "BL",
                "BM",
                "BN",
                "BO",
                "BQ",
                "BR",
                "BS",
                "BT",
                "BV",
                "BW",
                "BY",
                "BZ",
                "CA",
                "CC",
                "CD",
                "CF",
                "CG",
                "CH",
                "CI",
                "CK",
                "CL",
                "CM",
                "CN",
                "CO",
                "CR",
                "CU",
                "CV",
                "CW",
                "CX",
                "CY",
                "CZ",
                "DE",
                "DJ",
                "DK",
                "DM",
                "DO",
                "DZ",
                "EC",
                "EE",
                "EG",
                "EH",
                "ER",
                "ES",
                "ET",
                "FI",
                "FJ",
                "FK",
                "FM",
                "FO",
                "FR",
                "GA",
                "GB",
                "GD",
                "GE",
                "GF",
                "GG",
                "GH",
                "GI",
                "GL",
                "GM",
                "GN",
                "GP",
                "GQ",
                "GR",
                "GS",
                "GT",
                "GU",
                "GW",
                "GY",
                "HK",
                "HM",
                "HN",
                "HR",
                "HT",
                "HU",
                "ID",
                "IE",
                "IL",
                "IM",
                "IN",
                "IO",
                "IQ",
                "IR",
                "IS",
                "IT",
                "JE",
                "JM",
                "JO",
                "JP",
                "KE",
                "KG",
                "KH",
                "KI",
                "KM",
                "KN",
                "KP",
                "KR",
                "KW",
                "KY",
                "KZ",
                "LA",
                "LB",
                "LC",
                "LI",
                "LK",
                "LR",
                "LS",
                "LT",
                "LU",
                "LV",
                "LY",
                "MA",
                "MC",
                "MD",
                "ME",
                "MF",
                "MG",
                "MH",
                "MK",
                "ML",
                "MM",
                "MN",
                "MO",
                "MP",
                "MQ",
                "MR",
                "MS",
                "MT",
                "MU",
                "MV",
                "MW",
                "MX",
                "MY",
                "MZ",
                "NA",
                "NC",
                "NE",
                "NF",
                "NG",
                "NI",
                "NL",
                "NO",
                "NP",
                "NR",
                "NU",
                "NZ",
                "OM",
                "PA",
                "PE",
                "PF",
                "PG",
                "PH",
                "PK",
                "PL",
                "PM",
                "PN",
                "PR",
                "PS",
                "PT",
                "PW",
                "PY",
                "QA",
                "RE",
                "RO",
                "RS",
                "RU",
                "RW",
                "SA",
                "SB",
                "SC",
                "SD",
                "SE",
                "SG",
                "SH",
                "SI",
                "SJ",
                "SK",
                "SL",
                "SM",
                "SN",
                "SO",
                "SR",
                "SS",
                "ST",
                "SV",
                "SX",
                "SY",
                "SZ",
                "TC",
                "TD",
                "TF",
                "TG",
                "TH",
                "TJ",
                "TK",
                "TL",
                "TM",
                "TN",
                "TO",
                "TR",
                "TT",
                "TV",
                "TW",
                "TZ",
                "UA",
                "UG",
                "UM",
                "US",
                "UY",
                "UZ",
                "VA",
                "VC",
                "VE",
                "VG",
                "VI",
                "VN",
                "VU",
                "WF",
                "WS",
                "YE",
                "YT",
                "ZA",
                "ZM",
                "ZW",
                "XK"
              ],
              "description": "Country"
            },
            "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"
            },
            "user_id": {
              "type": "integer",
              "format": "int32",
              "description": "User ID linked to postal address"
            }
          }
        },
        "preferred_postal_address": {
          "type": "string",
          "description": "User preferred postal address"
        },
        "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"
        },
        "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"
        },
        "facebook_profile_url": {
          "type": "string",
          "description": "User facebook profile URL"
        },
        "honorary_title": {
          "type": "string",
          "description": "User's honorary title"
        },
        "custom_attributes": {
          "type": "array",
          "description": "Array of customizable attributes with name, value and type",
          "items": {
            "type": "string"
          }
        },
        "notify_after_create": {
          "type": "string"
        }
      },
      "required": [
        "email",
        "sub_network_ids"
      ]
    }
  },
  "required": [
    "users"
  ],
  "description": "Bulk add users"
}
Responses201422

Bulk add 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_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"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "User creation date time - iso8601"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "User last update date time - iso8601"
          },
          "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",
            "description": "User decease date"
          },
          "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"
          },
          "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": [
                  "AD",
                  "AE",
                  "AF",
                  "AG",
                  "AI",
                  "AL",
                  "AM",
                  "AO",
                  "AQ",
                  "AR",
                  "AS",
                  "AT",
                  "AU",
                  "AW",
                  "AX",
                  "AZ",
                  "BA",
                  "BB",
                  "BD",
                  "BE",
                  "BF",
                  "BG",
                  "BH",
                  "BI",
                  "BJ",
                  "BL",
                  "BM",
                  "BN",
                  "BO",
                  "BQ",
                  "BR",
                  "BS",
                  "BT",
                  "BV",
                  "BW",
                  "BY",
                  "BZ",
                  "CA",
                  "CC",
                  "CD",
                  "CF",
                  "CG",
                  "CH",
                  "CI",
                  "CK",
                  "CL",
                  "CM",
                  "CN",
                  "CO",
                  "CR",
                  "CU",
                  "CV",
                  "CW",
                  "CX",
                  "CY",
                  "CZ",
                  "DE",
                  "DJ",
                  "DK",
                  "DM",
                  "DO",
                  "DZ",
                  "EC",
                  "EE",
                  "EG",
                  "EH",
                  "ER",
                  "ES",
                  "ET",
                  "FI",
                  "FJ",
                  "FK",
                  "FM",
                  "FO",
                  "FR",
                  "GA",
                  "GB",
                  "GD",
                  "GE",
                  "GF",
                  "GG",
                  "GH",
                  "GI",
                  "GL",
                  "GM",
                  "GN",
                  "GP",
                  "GQ",
                  "GR",
                  "GS",
                  "GT",
                  "GU",
                  "GW",
                  "GY",
                  "HK",
                  "HM",
                  "HN",
                  "HR",
                  "HT",
                  "HU",
                  "ID",
                  "IE",
                  "IL",
                  "IM",
                  "IN",
                  "IO",
                  "IQ",
                  "IR",
                  "IS",
                  "IT",
                  "JE",
                  "JM",
                  "JO",
                  "JP",
                  "KE",
                  "KG",
                  "KH",
                  "KI",
                  "KM",
                  "KN",
                  "KP",
                  "KR",
                  "KW",
                  "KY",
                  "KZ",
                  "LA",
                  "LB",
                  "LC",
                  "LI",
                  "LK",
                  "LR",
                  "LS",
                  "LT",
                  "LU",
                  "LV",
                  "LY",
                  "MA",
                  "MC",
                  "MD",
                  "ME",
                  "MF",
                  "MG",
                  "MH",
                  "MK",
                  "ML",
                  "MM",
                  "MN",
                  "MO",
                  "MP",
                  "MQ",
                  "MR",
                  "MS",
                  "MT",
                  "MU",
                  "MV",
                  "MW",
                  "MX",
                  "MY",
                  "MZ",
                  "NA",
                  "NC",
                  "NE",
                  "NF",
                  "NG",
                  "NI",
                  "NL",
                  "NO",
                  "NP",
                  "NR",
                  "NU",
                  "NZ",
                  "OM",
                  "PA",
                  "PE",
                  "PF",
                  "PG",
                  "PH",
                  "PK",
                  "PL",
                  "PM",
                  "PN",
                  "PR",
                  "PS",
                  "PT",
                  "PW",
                  "PY",
                  "QA",
                  "RE",
                  "RO",
                  "RS",
                  "RU",
                  "RW",
                  "SA",
                  "SB",
                  "SC",
                  "SD",
                  "SE",
                  "SG",
                  "SH",
                  "SI",
                  "SJ",
                  "SK",
                  "SL",
                  "SM",
                  "SN",
                  "SO",
                  "SR",
                  "SS",
                  "ST",
                  "SV",
                  "SX",
                  "SY",
                  "SZ",
                  "TC",
                  "TD",
                  "TF",
                  "TG",
                  "TH",
                  "TJ",
                  "TK",
                  "TL",
                  "TM",
                  "TN",
                  "TO",
                  "TR",
                  "TT",
                  "TV",
                  "TW",
                  "TZ",
                  "UA",
                  "UG",
                  "UM",
                  "US",
                  "UY",
                  "UZ",
                  "VA",
                  "VC",
                  "VE",
                  "VG",
                  "VI",
                  "VN",
                  "VU",
                  "WF",
                  "WS",
                  "YE",
                  "YT",
                  "ZA",
                  "ZM",
                  "ZW",
                  "XK"
                ],
                "description": "Country"
              },
              "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"
              },
              "user_id": {
                "type": "integer",
                "format": "int32",
                "description": "User ID linked to postal address"
              }
            }
          },
          "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": [
                  "AD",
                  "AE",
                  "AF",
                  "AG",
                  "AI",
                  "AL",
                  "AM",
                  "AO",
                  "AQ",
                  "AR",
                  "AS",
                  "AT",
                  "AU",
                  "AW",
                  "AX",
                  "AZ",
                  "BA",
                  "BB",
                  "BD",
                  "BE",
                  "BF",
                  "BG",
                  "BH",
                  "BI",
                  "BJ",
                  "BL",
                  "BM",
                  "BN",
                  "BO",
                  "BQ",
                  "BR",
                  "BS",
                  "BT",
                  "BV",
                  "BW",
                  "BY",
                  "BZ",
                  "CA",
                  "CC",
                  "CD",
                  "CF",
                  "CG",
                  "CH",
                  "CI",
                  "CK",
                  "CL",
                  "CM",
                  "CN",
                  "CO",
                  "CR",
                  "CU",
                  "CV",
                  "CW",
                  "CX",
                  "CY",
                  "CZ",
                  "DE",
                  "DJ",
                  "DK",
                  "DM",
                  "DO",
                  "DZ",
                  "EC",
                  "EE",
                  "EG",
                  "EH",
                  "ER",
                  "ES",
                  "ET",
                  "FI",
                  "FJ",
                  "FK",
                  "FM",
                  "FO",
                  "FR",
                  "GA",
                  "GB",
                  "GD",
                  "GE",
                  "GF",
                  "GG",
                  "GH",
                  "GI",
                  "GL",
                  "GM",
                  "GN",
                  "GP",
                  "GQ",
                  "GR",
                  "GS",
                  "GT",
                  "GU",
                  "GW",
                  "GY",
                  "HK",
                  "HM",
                  "HN",
                  "HR",
                  "HT",
                  "HU",
                  "ID",
                  "IE",
                  "IL",
                  "IM",
                  "IN",
                  "IO",
                  "IQ",
                  "IR",
                  "IS",
                  "IT",
                  "JE",
                  "JM",
                  "JO",
                  "JP",
                  "KE",
                  "KG",
                  "KH",
                  "KI",
                  "KM",
                  "KN",
                  "KP",
                  "KR",
                  "KW",
                  "KY",
                  "KZ",
                  "LA",
                  "LB",
                  "LC",
                  "LI",
                  "LK",
                  "LR",
                  "LS",
                  "LT",
                  "LU",
                  "LV",
                  "LY",
                  "MA",
                  "MC",
                  "MD",
                  "ME",
                  "MF",
                  "MG",
                  "MH",
                  "MK",
                  "ML",
                  "MM",
                  "MN",
                  "MO",
                  "MP",
                  "MQ",
                  "MR",
                  "MS",
                  "MT",
                  "MU",
                  "MV",
                  "MW",
                  "MX",
                  "MY",
                  "MZ",
                  "NA",
                  "NC",
                  "NE",
                  "NF",
                  "NG",
                  "NI",
                  "NL",
                  "NO",
                  "NP",
                  "NR",
                  "NU",
                  "NZ",
                  "OM",
                  "PA",
                  "PE",
                  "PF",
                  "PG",
                  "PH",
                  "PK",
                  "PL",
                  "PM",
                  "PN",
                  "PR",
                  "PS",
                  "PT",
                  "PW",
                  "PY",
                  "QA",
                  "RE",
                  "RO",
                  "RS",
                  "RU",
                  "RW",
                  "SA",
                  "SB",
                  "SC",
                  "SD",
                  "SE",
                  "SG",
                  "SH",
                  "SI",
                  "SJ",
                  "SK",
                  "SL",
                  "SM",
                  "SN",
                  "SO",
                  "SR",
                  "SS",
                  "ST",
                  "SV",
                  "SX",
                  "SY",
                  "SZ",
                  "TC",
                  "TD",
                  "TF",
                  "TG",
                  "TH",
                  "TJ",
                  "TK",
                  "TL",
                  "TM",
                  "TN",
                  "TO",
                  "TR",
                  "TT",
                  "TV",
                  "TW",
                  "TZ",
                  "UA",
                  "UG",
                  "UM",
                  "US",
                  "UY",
                  "UZ",
                  "VA",
                  "VC",
                  "VE",
                  "VG",
                  "VI",
                  "VN",
                  "VU",
                  "WF",
                  "WS",
                  "YE",
                  "YT",
                  "ZA",
                  "ZM",
                  "ZW",
                  "XK"
                ],
                "description": "Country"
              },
              "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"
              },
              "user_id": {
                "type": "integer",
                "format": "int32",
                "description": "User ID linked to postal address"
              }
            }
          },
          "preferred_postal_address": {
            "type": "string",
            "enum": [
              "postal_personal",
              "postal_work"
            ],
            "description": "User preferred postal address"
          },
          "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"
          },
          "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": [
              "Pacific/Pago_Pago",
              "Pacific/Midway",
              "Pacific/Midway",
              "Pacific/Honolulu",
              "America/Juneau",
              "America/Los_Angeles",
              "America/Tijuana",
              "America/Phoenix",
              "America/Chihuahua",
              "America/Mazatlan",
              "America/Denver",
              "America/Guatemala",
              "America/Chicago",
              "America/Mexico_City",
              "America/Mexico_City",
              "America/Monterrey",
              "America/Regina",
              "America/Bogota",
              "America/New_York",
              "America/Indiana/Indianapolis",
              "America/Lima",
              "America/Lima",
              "America/Halifax",
              "America/Caracas",
              "America/Guyana",
              "America/La_Paz",
              "America/Santiago",
              "America/St_Johns",
              "America/Sao_Paulo",
              "America/Argentina/Buenos_Aires",
              "America/Godthab",
              "America/Montevideo",
              "Atlantic/South_Georgia",
              "Atlantic/Azores",
              "Atlantic/Cape_Verde",
              "Africa/Casablanca",
              "Europe/Dublin",
              "Europe/London",
              "Europe/Lisbon",
              "Europe/London",
              "Africa/Monrovia",
              "Etc/UTC",
              "Europe/Amsterdam",
              "Europe/Belgrade",
              "Europe/Berlin",
              "Europe/Berlin",
              "Europe/Bratislava",
              "Europe/Brussels",
              "Europe/Budapest",
              "Europe/Copenhagen",
              "Europe/Ljubljana",
              "Europe/Madrid",
              "Europe/Paris",
              "Europe/Prague",
              "Europe/Rome",
              "Europe/Sarajevo",
              "Europe/Skopje",
              "Europe/Stockholm",
              "Europe/Vienna",
              "Europe/Warsaw",
              "Africa/Algiers",
              "Europe/Zagreb",
              "Europe/Athens",
              "Europe/Bucharest",
              "Africa/Cairo",
              "Africa/Harare",
              "Europe/Helsinki",
              "Asia/Jerusalem",
              "Europe/Kaliningrad",
              "Europe/Kiev",
              "Africa/Johannesburg",
              "Europe/Riga",
              "Europe/Sofia",
              "Europe/Tallinn",
              "Europe/Vilnius",
              "Asia/Baghdad",
              "Europe/Istanbul",
              "Asia/Kuwait",
              "Europe/Minsk",
              "Europe/Moscow",
              "Africa/Nairobi",
              "Asia/Riyadh",
              "Europe/Moscow",
              "Europe/Volgograd",
              "Asia/Tehran",
              "Asia/Muscat",
              "Asia/Baku",
              "Asia/Muscat",
              "Europe/Samara",
              "Asia/Tbilisi",
              "Asia/Yerevan",
              "Asia/Kabul",
              "Asia/Yekaterinburg",
              "Asia/Karachi",
              "Asia/Karachi",
              "Asia/Tashkent",
              "Asia/Kolkata",
              "Asia/Kolkata",
              "Asia/Kolkata",
              "Asia/Kolkata",
              "Asia/Colombo",
              "Asia/Kathmandu",
              "Asia/Almaty",
              "Asia/Dhaka",
              "Asia/Dhaka",
              "Asia/Urumqi",
              "Asia/Rangoon",
              "Asia/Bangkok",
              "Asia/Bangkok",
              "Asia/Jakarta",
              "Asia/Krasnoyarsk",
              "Asia/Novosibirsk",
              "Asia/Shanghai",
              "Asia/Chongqing",
              "Asia/Hong_Kong",
              "Asia/Irkutsk",
              "Asia/Kuala_Lumpur",
              "Australia/Perth",
              "Asia/Singapore",
              "Asia/Taipei",
              "Asia/Ulaanbaatar",
              "Asia/Tokyo",
              "Asia/Tokyo",
              "Asia/Seoul",
              "Asia/Tokyo",
              "Asia/Yakutsk",
              "Australia/Adelaide",
              "Australia/Darwin",
              "Australia/Brisbane",
              "Australia/Melbourne",
              "Pacific/Guam",
              "Australia/Hobart",
              "Australia/Melbourne",
              "Pacific/Port_Moresby",
              "Australia/Sydney",
              "Asia/Vladivostok",
              "Asia/Magadan",
              "Pacific/Noumea",
              "Pacific/Guadalcanal",
              "Asia/Srednekolymsk",
              "Pacific/Auckland",
              "Pacific/Fiji",
              "Asia/Kamchatka",
              "Pacific/Majuro",
              "Pacific/Auckland",
              "Pacific/Chatham",
              "Pacific/Tongatapu",
              "Pacific/Apia",
              "Pacific/Fakaofo"
            ],
            "description": "User timezone"
          },
          "facebook_profile_url": {
            "type": "string",
            "description": "User facebook profile URL"
          },
          "honorary_title": {
            "type": "string",
            "enum": [
              "mr",
              "mrs",
              "ms",
              "dr",
              "prof"
            ],
            "description": "User's honorary title"
          },
          "live_location": {
            "description": "User's current location",
            "type": "object",
            "properties": {
              "city": {
                "type": "string",
                "description": "City"
              },
              "country": {
                "type": "string",
                "description": "Country"
              },
              "country_code": {
                "type": "string",
                "description": "ISO3166-2 Country code"
              },
              "address": {
                "type": "string",
                "description": "Address"
              },
              "lat": {
                "type": "number",
                "format": "float",
                "description": "Latitude"
              },
              "lng": {
                "type": "number",
                "format": "float",
                "description": "Longitude"
              }
            }
          },
          "custom_attributes": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Array of customizable attributes with name, value and type"
          }
        },
        "description": "## Update the user profile\n\nFind 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.\n\n"
      }
    }
  },
  "description": "# Batch update of users\n\nFind users using the ID setted in the `users` hash,\nor set `external_id` or `previous_id` as the **key** parameter to fetch users on these\nidentifier instead of default ID, and set the correct value for the ID params in `users`.\n\nWARNING: Swagger generated exemple of the parameters is false! You should use an **array** of users data\n\n```json\n{\n  \"users\": [\n    // User 1\n    {\n      \"id\": 1,\n      \"email\": \"string\",\n      \"sub_network_ids\": [\n        0\n      ],\n      ...\n    },\n    // User 2\n    {\n      \"id\": 2,\n      \"email\": \"string\",\n      \"sub_network_ids\": [\n        0\n      ],\n      ...\n    }\n  ]\n}\n```\n\n# Errors\n\nIf any users failed to update, the whole transaction is rollbacked\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

Bulk add users
POST/api/admin/v1/users/_bulk

Batch creation of users

Send invitation mail to the user

Set the params notify_after_create if you wish to automatically send an invitation to the user. Availables values to select on which email it should be sent are :

  • email

  • email2

  • email1then2

  • email2then1

  • email1and2

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

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

Errors

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


PUT /api/admin/v1/users/_bulk
Requests
Schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "users": {
      "type": "object",
      "properties": {
        "id": {
          "type": "array",
          "description": "User ID",
          "items": {
            "type": "string"
          }
        },
        "email": {
          "type": "array",
          "description": "User email",
          "items": {
            "type": "string"
          }
        },
        "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"
        },
        "firstname": {
          "type": "string",
          "description": "User first name"
        },
        "lastname": {
          "type": "string",
          "description": "User last name"
        },
        "maidenname": {
          "type": "string",
          "description": "User maiden name"
        },
        "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)"
        },
        "birthday": {
          "type": "string",
          "format": "date",
          "description": "User birth date"
        },
        "birthplace": {
          "type": "string",
          "description": "User birth place"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "User creation date time - iso8601"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "description": "User last update date time - iso8601"
        },
        "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",
          "description": "User decease date"
        },
        "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"
        },
        "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": [
                "AD",
                "AE",
                "AF",
                "AG",
                "AI",
                "AL",
                "AM",
                "AO",
                "AQ",
                "AR",
                "AS",
                "AT",
                "AU",
                "AW",
                "AX",
                "AZ",
                "BA",
                "BB",
                "BD",
                "BE",
                "BF",
                "BG",
                "BH",
                "BI",
                "BJ",
                "BL",
                "BM",
                "BN",
                "BO",
                "BQ",
                "BR",
                "BS",
                "BT",
                "BV",
                "BW",
                "BY",
                "BZ",
                "CA",
                "CC",
                "CD",
                "CF",
                "CG",
                "CH",
                "CI",
                "CK",
                "CL",
                "CM",
                "CN",
                "CO",
                "CR",
                "CU",
                "CV",
                "CW",
                "CX",
                "CY",
                "CZ",
                "DE",
                "DJ",
                "DK",
                "DM",
                "DO",
                "DZ",
                "EC",
                "EE",
                "EG",
                "EH",
                "ER",
                "ES",
                "ET",
                "FI",
                "FJ",
                "FK",
                "FM",
                "FO",
                "FR",
                "GA",
                "GB",
                "GD",
                "GE",
                "GF",
                "GG",
                "GH",
                "GI",
                "GL",
                "GM",
                "GN",
                "GP",
                "GQ",
                "GR",
                "GS",
                "GT",
                "GU",
                "GW",
                "GY",
                "HK",
                "HM",
                "HN",
                "HR",
                "HT",
                "HU",
                "ID",
                "IE",
                "IL",
                "IM",
                "IN",
                "IO",
                "IQ",
                "IR",
                "IS",
                "IT",
                "JE",
                "JM",
                "JO",
                "JP",
                "KE",
                "KG",
                "KH",
                "KI",
                "KM",
                "KN",
                "KP",
                "KR",
                "KW",
                "KY",
                "KZ",
                "LA",
                "LB",
                "LC",
                "LI",
                "LK",
                "LR",
                "LS",
                "LT",
                "LU",
                "LV",
                "LY",
                "MA",
                "MC",
                "MD",
                "ME",
                "MF",
                "MG",
                "MH",
                "MK",
                "ML",
                "MM",
                "MN",
                "MO",
                "MP",
                "MQ",
                "MR",
                "MS",
                "MT",
                "MU",
                "MV",
                "MW",
                "MX",
                "MY",
                "MZ",
                "NA",
                "NC",
                "NE",
                "NF",
                "NG",
                "NI",
                "NL",
                "NO",
                "NP",
                "NR",
                "NU",
                "NZ",
                "OM",
                "PA",
                "PE",
                "PF",
                "PG",
                "PH",
                "PK",
                "PL",
                "PM",
                "PN",
                "PR",
                "PS",
                "PT",
                "PW",
                "PY",
                "QA",
                "RE",
                "RO",
                "RS",
                "RU",
                "RW",
                "SA",
                "SB",
                "SC",
                "SD",
                "SE",
                "SG",
                "SH",
                "SI",
                "SJ",
                "SK",
                "SL",
                "SM",
                "SN",
                "SO",
                "SR",
                "SS",
                "ST",
                "SV",
                "SX",
                "SY",
                "SZ",
                "TC",
                "TD",
                "TF",
                "TG",
                "TH",
                "TJ",
                "TK",
                "TL",
                "TM",
                "TN",
                "TO",
                "TR",
                "TT",
                "TV",
                "TW",
                "TZ",
                "UA",
                "UG",
                "UM",
                "US",
                "UY",
                "UZ",
                "VA",
                "VC",
                "VE",
                "VG",
                "VI",
                "VN",
                "VU",
                "WF",
                "WS",
                "YE",
                "YT",
                "ZA",
                "ZM",
                "ZW",
                "XK"
              ],
              "description": "Country"
            },
            "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"
            },
            "user_id": {
              "type": "integer",
              "format": "int32",
              "description": "User ID linked to postal address"
            }
          }
        },
        "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": [
                "AD",
                "AE",
                "AF",
                "AG",
                "AI",
                "AL",
                "AM",
                "AO",
                "AQ",
                "AR",
                "AS",
                "AT",
                "AU",
                "AW",
                "AX",
                "AZ",
                "BA",
                "BB",
                "BD",
                "BE",
                "BF",
                "BG",
                "BH",
                "BI",
                "BJ",
                "BL",
                "BM",
                "BN",
                "BO",
                "BQ",
                "BR",
                "BS",
                "BT",
                "BV",
                "BW",
                "BY",
                "BZ",
                "CA",
                "CC",
                "CD",
                "CF",
                "CG",
                "CH",
                "CI",
                "CK",
                "CL",
                "CM",
                "CN",
                "CO",
                "CR",
                "CU",
                "CV",
                "CW",
                "CX",
                "CY",
                "CZ",
                "DE",
                "DJ",
                "DK",
                "DM",
                "DO",
                "DZ",
                "EC",
                "EE",
                "EG",
                "EH",
                "ER",
                "ES",
                "ET",
                "FI",
                "FJ",
                "FK",
                "FM",
                "FO",
                "FR",
                "GA",
                "GB",
                "GD",
                "GE",
                "GF",
                "GG",
                "GH",
                "GI",
                "GL",
                "GM",
                "GN",
                "GP",
                "GQ",
                "GR",
                "GS",
                "GT",
                "GU",
                "GW",
                "GY",
                "HK",
                "HM",
                "HN",
                "HR",
                "HT",
                "HU",
                "ID",
                "IE",
                "IL",
                "IM",
                "IN",
                "IO",
                "IQ",
                "IR",
                "IS",
                "IT",
                "JE",
                "JM",
                "JO",
                "JP",
                "KE",
                "KG",
                "KH",
                "KI",
                "KM",
                "KN",
                "KP",
                "KR",
                "KW",
                "KY",
                "KZ",
                "LA",
                "LB",
                "LC",
                "LI",
                "LK",
                "LR",
                "LS",
                "LT",
                "LU",
                "LV",
                "LY",
                "MA",
                "MC",
                "MD",
                "ME",
                "MF",
                "MG",
                "MH",
                "MK",
                "ML",
                "MM",
                "MN",
                "MO",
                "MP",
                "MQ",
                "MR",
                "MS",
                "MT",
                "MU",
                "MV",
                "MW",
                "MX",
                "MY",
                "MZ",
                "NA",
                "NC",
                "NE",
                "NF",
                "NG",
                "NI",
                "NL",
                "NO",
                "NP",
                "NR",
                "NU",
                "NZ",
                "OM",
                "PA",
                "PE",
                "PF",
                "PG",
                "PH",
                "PK",
                "PL",
                "PM",
                "PN",
                "PR",
                "PS",
                "PT",
                "PW",
                "PY",
                "QA",
                "RE",
                "RO",
                "RS",
                "RU",
                "RW",
                "SA",
                "SB",
                "SC",
                "SD",
                "SE",
                "SG",
                "SH",
                "SI",
                "SJ",
                "SK",
                "SL",
                "SM",
                "SN",
                "SO",
                "SR",
                "SS",
                "ST",
                "SV",
                "SX",
                "SY",
                "SZ",
                "TC",
                "TD",
                "TF",
                "TG",
                "TH",
                "TJ",
                "TK",
                "TL",
                "TM",
                "TN",
                "TO",
                "TR",
                "TT",
                "TV",
                "TW",
                "TZ",
                "UA",
                "UG",
                "UM",
                "US",
                "UY",
                "UZ",
                "VA",
                "VC",
                "VE",
                "VG",
                "VI",
                "VN",
                "VU",
                "WF",
                "WS",
                "YE",
                "YT",
                "ZA",
                "ZM",
                "ZW",
                "XK"
              ],
              "description": "Country"
            },
            "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"
            },
            "user_id": {
              "type": "integer",
              "format": "int32",
              "description": "User ID linked to postal address"
            }
          }
        },
        "preferred_postal_address": {
          "type": "string",
          "description": "User preferred postal address"
        },
        "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"
        },
        "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"
        },
        "facebook_profile_url": {
          "type": "string",
          "description": "User facebook profile URL"
        },
        "honorary_title": {
          "type": "string",
          "description": "User's honorary title"
        },
        "custom_attributes": {
          "type": "array",
          "description": "Array of customizable attributes with name, value and type",
          "items": {
            "type": "object"
          }
        }
      },
      "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_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"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "User creation date time - iso8601"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "User last update date time - iso8601"
          },
          "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",
            "description": "User decease date"
          },
          "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"
          },
          "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": [
                  "AD",
                  "AE",
                  "AF",
                  "AG",
                  "AI",
                  "AL",
                  "AM",
                  "AO",
                  "AQ",
                  "AR",
                  "AS",
                  "AT",
                  "AU",
                  "AW",
                  "AX",
                  "AZ",
                  "BA",
                  "BB",
                  "BD",
                  "BE",
                  "BF",
                  "BG",
                  "BH",
                  "BI",
                  "BJ",
                  "BL",
                  "BM",
                  "BN",
                  "BO",
                  "BQ",
                  "BR",
                  "BS",
                  "BT",
                  "BV",
                  "BW",
                  "BY",
                  "BZ",
                  "CA",
                  "CC",
                  "CD",
                  "CF",
                  "CG",
                  "CH",
                  "CI",
                  "CK",
                  "CL",
                  "CM",
                  "CN",
                  "CO",
                  "CR",
                  "CU",
                  "CV",
                  "CW",
                  "CX",
                  "CY",
                  "CZ",
                  "DE",
                  "DJ",
                  "DK",
                  "DM",
                  "DO",
                  "DZ",
                  "EC",
                  "EE",
                  "EG",
                  "EH",
                  "ER",
                  "ES",
                  "ET",
                  "FI",
                  "FJ",
                  "FK",
                  "FM",
                  "FO",
                  "FR",
                  "GA",
                  "GB",
                  "GD",
                  "GE",
                  "GF",
                  "GG",
                  "GH",
                  "GI",
                  "GL",
                  "GM",
                  "GN",
                  "GP",
                  "GQ",
                  "GR",
                  "GS",
                  "GT",
                  "GU",
                  "GW",
                  "GY",
                  "HK",
                  "HM",
                  "HN",
                  "HR",
                  "HT",
                  "HU",
                  "ID",
                  "IE",
                  "IL",
                  "IM",
                  "IN",
                  "IO",
                  "IQ",
                  "IR",
                  "IS",
                  "IT",
                  "JE",
                  "JM",
                  "JO",
                  "JP",
                  "KE",
                  "KG",
                  "KH",
                  "KI",
                  "KM",
                  "KN",
                  "KP",
                  "KR",
                  "KW",
                  "KY",
                  "KZ",
                  "LA",
                  "LB",
                  "LC",
                  "LI",
                  "LK",
                  "LR",
                  "LS",
                  "LT",
                  "LU",
                  "LV",
                  "LY",
                  "MA",
                  "MC",
                  "MD",
                  "ME",
                  "MF",
                  "MG",
                  "MH",
                  "MK",
                  "ML",
                  "MM",
                  "MN",
                  "MO",
                  "MP",
                  "MQ",
                  "MR",
                  "MS",
                  "MT",
                  "MU",
                  "MV",
                  "MW",
                  "MX",
                  "MY",
                  "MZ",
                  "NA",
                  "NC",
                  "NE",
                  "NF",
                  "NG",
                  "NI",
                  "NL",
                  "NO",
                  "NP",
                  "NR",
                  "NU",
                  "NZ",
                  "OM",
                  "PA",
                  "PE",
                  "PF",
                  "PG",
                  "PH",
                  "PK",
                  "PL",
                  "PM",
                  "PN",
                  "PR",
                  "PS",
                  "PT",
                  "PW",
                  "PY",
                  "QA",
                  "RE",
                  "RO",
                  "RS",
                  "RU",
                  "RW",
                  "SA",
                  "SB",
                  "SC",
                  "SD",
                  "SE",
                  "SG",
                  "SH",
                  "SI",
                  "SJ",
                  "SK",
                  "SL",
                  "SM",
                  "SN",
                  "SO",
                  "SR",
                  "SS",
                  "ST",
                  "SV",
                  "SX",
                  "SY",
                  "SZ",
                  "TC",
                  "TD",
                  "TF",
                  "TG",
                  "TH",
                  "TJ",
                  "TK",
                  "TL",
                  "TM",
                  "TN",
                  "TO",
                  "TR",
                  "TT",
                  "TV",
                  "TW",
                  "TZ",
                  "UA",
                  "UG",
                  "UM",
                  "US",
                  "UY",
                  "UZ",
                  "VA",
                  "VC",
                  "VE",
                  "VG",
                  "VI",
                  "VN",
                  "VU",
                  "WF",
                  "WS",
                  "YE",
                  "YT",
                  "ZA",
                  "ZM",
                  "ZW",
                  "XK"
                ],
                "description": "Country"
              },
              "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"
              },
              "user_id": {
                "type": "integer",
                "format": "int32",
                "description": "User ID linked to postal address"
              }
            }
          },
          "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": [
                  "AD",
                  "AE",
                  "AF",
                  "AG",
                  "AI",
                  "AL",
                  "AM",
                  "AO",
                  "AQ",
                  "AR",
                  "AS",
                  "AT",
                  "AU",
                  "AW",
                  "AX",
                  "AZ",
                  "BA",
                  "BB",
                  "BD",
                  "BE",
                  "BF",
                  "BG",
                  "BH",
                  "BI",
                  "BJ",
                  "BL",
                  "BM",
                  "BN",
                  "BO",
                  "BQ",
                  "BR",
                  "BS",
                  "BT",
                  "BV",
                  "BW",
                  "BY",
                  "BZ",
                  "CA",
                  "CC",
                  "CD",
                  "CF",
                  "CG",
                  "CH",
                  "CI",
                  "CK",
                  "CL",
                  "CM",
                  "CN",
                  "CO",
                  "CR",
                  "CU",
                  "CV",
                  "CW",
                  "CX",
                  "CY",
                  "CZ",
                  "DE",
                  "DJ",
                  "DK",
                  "DM",
                  "DO",
                  "DZ",
                  "EC",
                  "EE",
                  "EG",
                  "EH",
                  "ER",
                  "ES",
                  "ET",
                  "FI",
                  "FJ",
                  "FK",
                  "FM",
                  "FO",
                  "FR",
                  "GA",
                  "GB",
                  "GD",
                  "GE",
                  "GF",
                  "GG",
                  "GH",
                  "GI",
                  "GL",
                  "GM",
                  "GN",
                  "GP",
                  "GQ",
                  "GR",
                  "GS",
                  "GT",
                  "GU",
                  "GW",
                  "GY",
                  "HK",
                  "HM",
                  "HN",
                  "HR",
                  "HT",
                  "HU",
                  "ID",
                  "IE",
                  "IL",
                  "IM",
                  "IN",
                  "IO",
                  "IQ",
                  "IR",
                  "IS",
                  "IT",
                  "JE",
                  "JM",
                  "JO",
                  "JP",
                  "KE",
                  "KG",
                  "KH",
                  "KI",
                  "KM",
                  "KN",
                  "KP",
                  "KR",
                  "KW",
                  "KY",
                  "KZ",
                  "LA",
                  "LB",
                  "LC",
                  "LI",
                  "LK",
                  "LR",
                  "LS",
                  "LT",
                  "LU",
                  "LV",
                  "LY",
                  "MA",
                  "MC",
                  "MD",
                  "ME",
                  "MF",
                  "MG",
                  "MH",
                  "MK",
                  "ML",
                  "MM",
                  "MN",
                  "MO",
                  "MP",
                  "MQ",
                  "MR",
                  "MS",
                  "MT",
                  "MU",
                  "MV",
                  "MW",
                  "MX",
                  "MY",
                  "MZ",
                  "NA",
                  "NC",
                  "NE",
                  "NF",
                  "NG",
                  "NI",
                  "NL",
                  "NO",
                  "NP",
                  "NR",
                  "NU",
                  "NZ",
                  "OM",
                  "PA",
                  "PE",
                  "PF",
                  "PG",
                  "PH",
                  "PK",
                  "PL",
                  "PM",
                  "PN",
                  "PR",
                  "PS",
                  "PT",
                  "PW",
                  "PY",
                  "QA",
                  "RE",
                  "RO",
                  "RS",
                  "RU",
                  "RW",
                  "SA",
                  "SB",
                  "SC",
                  "SD",
                  "SE",
                  "SG",
                  "SH",
                  "SI",
                  "SJ",
                  "SK",
                  "SL",
                  "SM",
                  "SN",
                  "SO",
                  "SR",
                  "SS",
                  "ST",
                  "SV",
                  "SX",
                  "SY",
                  "SZ",
                  "TC",
                  "TD",
                  "TF",
                  "TG",
                  "TH",
                  "TJ",
                  "TK",
                  "TL",
                  "TM",
                  "TN",
                  "TO",
                  "TR",
                  "TT",
                  "TV",
                  "TW",
                  "TZ",
                  "UA",
                  "UG",
                  "UM",
                  "US",
                  "UY",
                  "UZ",
                  "VA",
                  "VC",
                  "VE",
                  "VG",
                  "VI",
                  "VN",
                  "VU",
                  "WF",
                  "WS",
                  "YE",
                  "YT",
                  "ZA",
                  "ZM",
                  "ZW",
                  "XK"
                ],
                "description": "Country"
              },
              "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"
              },
              "user_id": {
                "type": "integer",
                "format": "int32",
                "description": "User ID linked to postal address"
              }
            }
          },
          "preferred_postal_address": {
            "type": "string",
            "enum": [
              "postal_personal",
              "postal_work"
            ],
            "description": "User preferred postal address"
          },
          "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"
          },
          "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": [
              "Pacific/Pago_Pago",
              "Pacific/Midway",
              "Pacific/Midway",
              "Pacific/Honolulu",
              "America/Juneau",
              "America/Los_Angeles",
              "America/Tijuana",
              "America/Phoenix",
              "America/Chihuahua",
              "America/Mazatlan",
              "America/Denver",
              "America/Guatemala",
              "America/Chicago",
              "America/Mexico_City",
              "America/Mexico_City",
              "America/Monterrey",
              "America/Regina",
              "America/Bogota",
              "America/New_York",
              "America/Indiana/Indianapolis",
              "America/Lima",
              "America/Lima",
              "America/Halifax",
              "America/Caracas",
              "America/Guyana",
              "America/La_Paz",
              "America/Santiago",
              "America/St_Johns",
              "America/Sao_Paulo",
              "America/Argentina/Buenos_Aires",
              "America/Godthab",
              "America/Montevideo",
              "Atlantic/South_Georgia",
              "Atlantic/Azores",
              "Atlantic/Cape_Verde",
              "Africa/Casablanca",
              "Europe/Dublin",
              "Europe/London",
              "Europe/Lisbon",
              "Europe/London",
              "Africa/Monrovia",
              "Etc/UTC",
              "Europe/Amsterdam",
              "Europe/Belgrade",
              "Europe/Berlin",
              "Europe/Berlin",
              "Europe/Bratislava",
              "Europe/Brussels",
              "Europe/Budapest",
              "Europe/Copenhagen",
              "Europe/Ljubljana",
              "Europe/Madrid",
              "Europe/Paris",
              "Europe/Prague",
              "Europe/Rome",
              "Europe/Sarajevo",
              "Europe/Skopje",
              "Europe/Stockholm",
              "Europe/Vienna",
              "Europe/Warsaw",
              "Africa/Algiers",
              "Europe/Zagreb",
              "Europe/Athens",
              "Europe/Bucharest",
              "Africa/Cairo",
              "Africa/Harare",
              "Europe/Helsinki",
              "Asia/Jerusalem",
              "Europe/Kaliningrad",
              "Europe/Kiev",
              "Africa/Johannesburg",
              "Europe/Riga",
              "Europe/Sofia",
              "Europe/Tallinn",
              "Europe/Vilnius",
              "Asia/Baghdad",
              "Europe/Istanbul",
              "Asia/Kuwait",
              "Europe/Minsk",
              "Europe/Moscow",
              "Africa/Nairobi",
              "Asia/Riyadh",
              "Europe/Moscow",
              "Europe/Volgograd",
              "Asia/Tehran",
              "Asia/Muscat",
              "Asia/Baku",
              "Asia/Muscat",
              "Europe/Samara",
              "Asia/Tbilisi",
              "Asia/Yerevan",
              "Asia/Kabul",
              "Asia/Yekaterinburg",
              "Asia/Karachi",
              "Asia/Karachi",
              "Asia/Tashkent",
              "Asia/Kolkata",
              "Asia/Kolkata",
              "Asia/Kolkata",
              "Asia/Kolkata",
              "Asia/Colombo",
              "Asia/Kathmandu",
              "Asia/Almaty",
              "Asia/Dhaka",
              "Asia/Dhaka",
              "Asia/Urumqi",
              "Asia/Rangoon",
              "Asia/Bangkok",
              "Asia/Bangkok",
              "Asia/Jakarta",
              "Asia/Krasnoyarsk",
              "Asia/Novosibirsk",
              "Asia/Shanghai",
              "Asia/Chongqing",
              "Asia/Hong_Kong",
              "Asia/Irkutsk",
              "Asia/Kuala_Lumpur",
              "Australia/Perth",
              "Asia/Singapore",
              "Asia/Taipei",
              "Asia/Ulaanbaatar",
              "Asia/Tokyo",
              "Asia/Tokyo",
              "Asia/Seoul",
              "Asia/Tokyo",
              "Asia/Yakutsk",
              "Australia/Adelaide",
              "Australia/Darwin",
              "Australia/Brisbane",
              "Australia/Melbourne",
              "Pacific/Guam",
              "Australia/Hobart",
              "Australia/Melbourne",
              "Pacific/Port_Moresby",
              "Australia/Sydney",
              "Asia/Vladivostok",
              "Asia/Magadan",
              "Pacific/Noumea",
              "Pacific/Guadalcanal",
              "Asia/Srednekolymsk",
              "Pacific/Auckland",
              "Pacific/Fiji",
              "Asia/Kamchatka",
              "Pacific/Majuro",
              "Pacific/Auckland",
              "Pacific/Chatham",
              "Pacific/Tongatapu",
              "Pacific/Apia",
              "Pacific/Fakaofo"
            ],
            "description": "User timezone"
          },
          "facebook_profile_url": {
            "type": "string",
            "description": "User facebook profile URL"
          },
          "honorary_title": {
            "type": "string",
            "enum": [
              "mr",
              "mrs",
              "ms",
              "dr",
              "prof"
            ],
            "description": "User's honorary title"
          },
          "live_location": {
            "description": "User's current location",
            "type": "object",
            "properties": {
              "city": {
                "type": "string",
                "description": "City"
              },
              "country": {
                "type": "string",
                "description": "Country"
              },
              "country_code": {
                "type": "string",
                "description": "ISO3166-2 Country code"
              },
              "address": {
                "type": "string",
                "description": "Address"
              },
              "lat": {
                "type": "number",
                "format": "float",
                "description": "Latitude"
              },
              "lng": {
                "type": "number",
                "format": "float",
                "description": "Longitude"
              }
            }
          },
          "custom_attributes": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Array of customizable attributes with name, value and type"
          }
        },
        "description": "## Update the user profile\n\nFind 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.\n\n"
      }
    }
  },
  "description": "# Batch update of users\n\nFind users using the ID setted in the `users` hash,\nor set `external_id` or `previous_id` as the **key** parameter to fetch users on these\nidentifier instead of default ID, and set the correct value for the ID params in `users`.\n\nWARNING: Swagger generated exemple of the parameters is false! You should use an **array** of users data\n\n```json\n{\n  \"users\": [\n    // User 1\n    {\n      \"id\": 1,\n      \"email\": \"string\",\n      \"sub_network_ids\": [\n        0\n      ],\n      ...\n    },\n    // User 2\n    {\n      \"id\": 2,\n      \"email\": \"string\",\n      \"sub_network_ids\": [\n        0\n      ],\n      ...\n    }\n  ]\n}\n```\n\n# Errors\n\nIf any users failed to update, the whole transaction is rollbacked\n"
}

Validations Failed

Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32",
      "description": "Status Code"
    },
    "errors": {
      "type": "string",
      "description": "Errors list"
    }
  },
  "description": "\n## Return the updated business opportunity profile based on its ID\nUpdates the business opportunity matching its ID.\n\n"
}

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.

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/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) 

educations

Operations about educations

GET /api/admin/v1/educations
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"
          },
          "external_id": {
            "type": "string",
            "description": "Education ID in your database"
          },
          "user_id": {
            "type": "integer",
            "format": "int32",
            "description": "User linked to education"
          },
          "field_of_study": {
            "description": "Field of study linked to Education",
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "format": "int32",
                "description": "Unique ID"
              },
              "name": {
                "type": "string",
                "description": "Field of study name"
              }
            }
          },
          "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"
          },
          "extended_updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Education (including custom attributes) last update date time - iso8601"
          }
        },
        "description": "## Update a user education\n\nFind the user education matching its ID,or use `external_id` as the **education_key** parameter to identify the education instead of default Education ID.\n\n"
      }
    }
  },
  "description": "\n## Return an array of educations with basic informations\n\nUse the param `updated_since` to fetch all educations updated\nsince this datetime (e.g. `updated_since=2017-08-01T00:00:00`)\n\nUse the param `order` to choose on which criterias the results\nshould be ordered (e.g. `order=extended_updated_at` to order by\nextended_updated_at descending, use the minus operator to order\nby ascending value e.g. `order=-extended_updated_at`).\n\nPagination information are stored in the response header as defined by RFC-5988\nhttp://tools.ietf.org/html/rfc5988\n\nExample:\n```json\n{\n\"link\": \"<https://hivebrite.com/api/admin/v1/educations?page=1&per_page=30>; rel=\\\"first\\\", <https://hivebrite.com/api/admin/v1/educations?page=3&per_page=30>; rel=\\\"prev\\\", <https://hivebrite.com/api/admin/v1//educations?page=2041&per_page=30>; rel=\\\"last\\\", <https://hivebrite.com/api/admin/v1/educations?page=30&per_page=30>; rel=\\\"next\\\"\",\n\"x-per-page\": \"30\",\n\"x-total\": \"10201\",\n\"x-page\": \"4\"\n}\n```\n\n"
}

Get all user educations
GET/api/admin/v1/educations

Return an array of educations with basic informations

Use the param updated_since to fetch all educations 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=extended_updated_at to order by extended_updated_at descending, use the minus operator to order by ascending value e.g. order=-extended_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/educations?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/educations?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1//educations?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/educations?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/educations/id?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"
    },
    "external_id": {
      "type": "string",
      "description": "Education ID in your database"
    },
    "user_id": {
      "type": "integer",
      "format": "int32",
      "description": "User linked to education"
    },
    "field_of_study": {
      "description": "Field of study linked to Education",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "Unique ID"
        },
        "name": {
          "type": "string",
          "description": "Field of study name"
        }
      }
    },
    "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"
    },
    "extended_updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Education (including custom attributes) last update date time - iso8601"
    }
  },
  "description": "## Update a user education\n\nFind the user education matching its ID,or use `external_id` as the **education_key** parameter to identify the education instead of default Education ID.\n\n"
}

Get user education
GET/api/admin/v1/educations/{id}{?education_key}

Return the user education based on its ID

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

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

PUT /api/admin/v1/educations/id
Requests
Body
{
  "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[external_id]": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "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[external_id]": {
      "type": "string",
      "description": "Education ID in your database"
    }
  },
  "$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":