Skip to main content

Create Usergroup Address

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

Path Parameters

    lookupKey stringrequired

    Lookup key. Read more about usergroup lookup keys

    lookupValue stringrequired

    The value of the key (id or sourceId)

Body

    city string
    code string
    company string
    country string
    email string
    firstName string
    icp string
    lastName string
    middleName string
    mobile string
    notes string
    number string
    numberExtension string
    phone string
    postalCode string
    region string
    street string
    type string
    url string

Responses

Create Usergroup Address - 201

Response Headers

  • Alt-Svc

    string

  • Via

    string

  • alt-svc

    string

  • content-length

    string

  • date

    string

  • return-format

    string

  • server

    string

  • x-request-id

    string

Schema

    data

    object

    city string
    code string
    company string
    country string
    email string
    firstName string
    icp string
    id number
    isDefault string
    lastName string
    middleName string
    mobile string
    notes string
    number string
    numberExtension string
    phone string
    postalCode string
    region string
    street string
    type string
    url string
    messages string[]
    total number
Loading...