Update Usergroup Address

PATCH 
/usergroups/:lookupKey/:lookupValue/addresses/:addressId

Use this endpoint to update a usergroup address. The address is identified by id.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about usergroup lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

addressId stringrequired

Address id

application/json

Body

firstNames string
lastName string

Responses

200

Update Usergroup Address by Id - 200

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

firstName string

id number

lastName string
messages string[]
total number

Example (from schema)

{
  "data": {
    "firstName": "Miles",
    "id": 81918,
    "lastName": "McCoy"
  },
  "messages": [
    "Address updated"
  ],
  "total": 1
}

Update Usergroup Address by Id - 200

{
  "data": {
    "firstName": "Miles",
    "id": 81918,
    "lastName": "McCoy"
  },
  "messages": [
    "Address updated"
  ],
  "total": 1
}

400

Update Usergroup Address by Id - 400 (invalid schema)

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": [
      "#: extraneous key [firstNames] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Update Usergroup Address by Id - 400 (invalid schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [firstNames] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

404

Update Usergroup Address by Id - 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"
  }
}

Update Usergroup Address by Id - 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...