Skip to main content

Create Usergroup Address

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/

Use this endpoint to create an address for a usergroup. If the address is successfully created, the response will include the address id.

Fields​

NameRequired
typeyes
codeno
firstNameno
middleNameno
lastNameno
genderno
Default is U
streetyes
numberno
numberExtensionno
postalCodeno
cityyes
countryyes
regionno
icpno

Default is N
phoneno
mobileno
emailno
companyno
urlno
isDefaultno

Default is N
notesno

Request​

Responses​

Create Usergroup Address - 201

Response Headers
    Alt-Svc
    Via
    alt-svc
    content-length
    date
    return-format
    server
    x-request-id