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

Name	Required
type	yes
code	no
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

Path Parameters

lookupKey stringrequired

Lookup key. Read more about usergroup lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

application/json

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

201

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

application/json

Schema

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

Example (from schema)

{
  "data": {
    "city": "Arnhem",
    "code": "11234",
    "company": "Propel",
    "country": "NL",
    "email": "miles@propel.us",
    "firstName": "Miles",
    "icp": "N",
    "id": 81918,
    "isDefault": "Y",
    "lastName": "McCoy",
    "middleName": "",
    "mobile": "0038975648",
    "notes": "Address notes",
    "number": "34",
    "numberExtension": "A",
    "phone": "0032445888",
    "postalCode": "6822 DE",
    "region": "",
    "street": "Noordpad",
    "type": "delivery",
    "url": "www.propel.us"
  },
  "messages": [
    "Address created"
  ],
  "total": 1
}

Create Usergroup Address - 201

{
  "data": {
    "city": "Arnhem",
    "code": "11234",
    "company": "Propel",
    "country": "NL",
    "email": "miles@propel.us",
    "firstName": "Miles",
    "icp": "N",
    "id": 81918,
    "isDefault": "Y",
    "lastName": "McCoy",
    "middleName": "",
    "mobile": "0038975648",
    "notes": "Address notes",
    "number": "34",
    "numberExtension": "A",
    "phone": "0032445888",
    "postalCode": "6822 DE",
    "region": "",
    "street": "Noordpad",
    "type": "delivery",
    "url": "www.propel.us"
  },
  "messages": [
    "Address created"
  ],
  "total": 1
}

400

Create Usergroup Address - 400

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#/isDefault: U is not a valid enum value"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Create Usergroup Address - 400

{
  "error": {
    "code": 10007,
    "messages": [
      "#/isDefault: U is not a valid enum value"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

404

Create Usergroup Address - 404

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 20007,
    "messages": [
      "Parent resource [Usergroup] with id [12256] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20007",
    "status": 404,
    "type": "ParentUsergroupNotFound"
  }
}

Create Usergroup Address - 404

{
  "error": {
    "code": 20007,
    "messages": [
      "Parent resource [Usergroup] with id [12256] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20007",
    "status": 404,
    "type": "ParentUsergroupNotFound"
  }
}

Loading...