Bulk Usergroup Addresses
Legacy Documentation
You are viewing legacy documentation. These APIs are maintained for partners with existing implementations. New projects should use v2.
View the current GraphQL API Reference → | View the current REST API Reference →
POST/usergroups/:lookupKey/:lookupValue/addresses/bulk
Use this endpoint to create multiple usergroup addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address id.
Fields
| Name | Required |
|---|---|
type | yes |
code | yes |
firstName | no |
middleName | no |
lastName | no |
gender | no Default is U |
street | yes |
number | no |
numberExtension | no |
postalCode | no |
city | yes |
country | yes |
region | no |
icp | no Default is N |
phone | no |
mobile | no |
email | no |
company | no |
url | no |
isDefault | no Default is N |
notes | no |
Request
Responses
- 201
- 400
- 404
Bulk Usergroup Addresses - 201
Response Headers
Alt-Svc
Via
alt-svc
content-length
date
return-format
server
x-request-id
Bulk Usergroup Addresses - 400
Response Headers
Alt-Svc
Via
alt-svc
content-length
date
return-format
server
x-request-id
Bulk Usergroup Addresses - 404
Response Headers
Alt-Svc
Via
alt-svc
content-length
date
return-format
server
x-request-id