POST /users/bulkupdate

Service endpoint that lets to perform 1 to 10 operations to create, read, update or delete users and assign Spaces license to new created or existing user. Only service app authentication is permitted. User emails must belong to the same company that owns service app. Service app must have "accounts.users.bulk.write" scope to use this endpoint.

Supported actions

URL Parameters

None.

Body Parameters

Authentication

ServiceAppAuthenticator

Authorization

None

Example Request

URL

For Production: POST https://accounts.avayacloud.com/api/1.0/users/bulkupdate

For Staging: POST https://onesnastaging.esna.com/api/1.0/users/bulkupdate

Headers

Authorization: "service_app eyJhbGciOiJSUzI1NiIsIdfgdfgnR5cCI6IkpXVCJ9.eyJ1c2VyX2lkX3NpZyI6ImxPWHpxNzVzR3J3X0xwWEMyRGRMakhyYXJlWVhyTzFMdEZHZkhkOWNkTXciLCJwcm9kdWN0X3R5cGUiOiJhY2NvdW50cyIsImxhc3R1cGRhdGV0aW1lIjoiMjAxNy0wMS0zMFQxMzo1ODo0Ny4yMDYiLCJpc3MiOiJ6YW5nLmlvIiwicHVibGlja2V5aWQiOiJhZ3h6Zm05dVpYTnVZVEl3TVRSeUdnc1NEVWRLZDNSUWRXSnNhV05MWlhrdfgdWdJQ2dsUEtFakFvTSIsImV4cCI6MTQ5NTM5MTIwMywidXNlcl9pZCI6ImFneHpmbTl1WlhOdVlUSXdNVFJ5RVFzU0JGVnpaWElZZ0lEQXMtX25fUW9NIiwidmVyIjoiMi4wIn0.SqZpw1uPIebqW3qlDsm0-DWYFKEH0SgPwtD-tSESWOF-5hLkZMqJH28ooWux2S7s9riIew7pTVPnZpTgJa5zHcEAG0gXSEJVOqmpGp_4ufM8YtZoZMpBFjyAkwyAt-ILkGUYIo0GU5WyzMPLV8YLXfgdfgOgkE2MGGOajBkjPmC2Db3pA0D0M9k-21EL1gwWBC5YIq0PDAkgulegwl6khRmB8irJQ-dfg-d-KV9eYfFpsCdJKRGzSfqg"

Body

[{
  "action": "create",
  "email": "user1@somecompany.com",
  "password": "password",
  "firstname": "firstname",
  "lastname": "lastname",
  "language": "fr",
  "cellphone": "+37066111111",
  "workphone": "+37066222222",
  "license_type": "spaces_business"
}]

Example Response

If requested action is "merge" and user did not exist ("create" action was performed), endpoint returns

"action": "merge.create"

If requested action is "merge" and user existed ("update" action was performed), endpoint returns

"action": "merge.update"

{
  "action": "create",
  "status": "success",
  "data": {
    "id": "aghkZXZ-Tm9uZXIRCxIEVXNlchiAgICAoPSKCAw",
    "username": "user1@somecompany.com",
    "name": {
      "familyname": "lastname",
      "formatted": "",
      "givenname": "firstname",
      "honorific_prefix": "",
      "honorific_suffix": "",
      "middlename": "",
      "pronunciation": "",
      "pronunciation_url": ""
    },
    "last_login": null,
    "date_joined": "2021-09-07T08:17:42.936000",
    "lastmodifiedversion": "2021-09-07T08:17:45.350000",
    "user_action_required": 0,
    "emails": [{
      "value": "user3@newcompany.com",
      "type": "",
      "primary": true,
      "label": "",
      "relationdef_id": "aghkZXZ-Tm9uZXIYCxILUmVsYXRpb25EZWYYgICAgKD0igoM"
    }],
    "languages ": [{
      "code": "fr-FR",
      "primary": true
    }],
    "timezone": "",
    "picture_url": "http://localhost:9000/norevimages/noimage.jpg",
    "relation_graphs": [{
      "relationdef_id": "aghkZXZ-Tm9uZXIYCxILUmVsYXRpb25EZWYYgICAgKD0igoM",
      "initiator_id": "aghkZXZ-Tm9uZXIUCxIHQ29tcGFueRiAgICAgOqUCQw",
      "initiator_type": "company",
      "relation_type": "employee"
    }],
    "phone_numbers": [{
      "value": "+37066222222",
      "type": "work",
      "canonicalForm": "+37066222222",
      "primary": true,
      "verified": false,
      "identity": false,
      "login": false,
      "unique": false,
      "qualified_method": "",
      "verify_method": "",
      "verified_on": null,
      "private_num": false,
      "formattedType": "Work"
    },
    {
      "value": "+37066111111",
      "type": "mobile",
      "canonicalForm": "+37066111111",
      "primary": false,
      "verified": false,
      "identity": false,
      "login": false,
      "unique": false,
      "qualified_method": "",
      "verify_method": "",
      "verified_on": null,
      "private_num": true,
      "formattedType": "Mobile"
    }
    ],
    "addresses": [],
    "gender": "",
    "displayname": "firstname lastname",
    "permissions": [
      //user's permissions
    ],
    "licenses": [{
      "purchased_license_id": "aghkZXZ-Tm9uZXIdCxIQUHVyY2hhc2VkTGljZW5zZRiAgICAgL_vCAw",
      "service_type": "zangspaces_business",
      "product_type": "zangspaces",
      "expiration": "2022-02-01T09:00:00",
      "parentid": "aghkZXZ-Tm9uZXIUCxIHQ29tcGFueRiAgICAgOqUCQw",
      "parent_type": "company",
      "trial": false,
      "allocated": "2021-09-07T08:17:46.713000",
      "parent_displayname": "new_company"
    }]
  }
}

Errors

General errors

Response example:

{
  "error": {
    "message": "User bulk API invalid data: list required",
    "code": "user_bulk.list_required"
  }
}

Field errors

Endpoint return errors for every object that does not fit requirements.

Error code is dot-separated location (field) and reason.

Example:

{
  "action": "create",
  "errors": [{
    "message": "User already exists.",
    "code": "email.user_exists"
  }],
  "status": "error"
}

Warnings

Endpoint returns warnings if user was successfully created or updated but Spaces license can not be assigned.

For example:

{
  "action": "create",
  "status": "success",
  "warnings": [{
    "code": "license.assigning_error",
    "message": "Can not assign "spaces_business" license to user"
  }],
  "data": {
    //user data
  },  
}

Possible error codes are :

• "license.assigning_error" - Can not assign specific license to user.
• "license.not_found" - Company does not have Spaces license.