Update an existing pickup group

This action will update an existing pickup group matching the given ID.

Try this request in your browser

/api/ /pickup_groups/update

Headers

X-Auth-App
X-Auth-Token
X-Auth-Secret
X-Auth-Extension
X-Auth-Password
X-Proxy-Auth-Token
X-Proxy-Auth-Secret

Parameters

id String
name String 

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/pickup_groups/update

Access

Must be authenticated as a user or API token. If not authorised, a AccessDenied error will be returned.

Parameters

Parameter Type Default

id Required

The ID of the pickup group

 String null

name

The name

 String null

Errors

Error Attributes

PickupGroupNotFound

No pickup group was found given the ID provided

  • id

    The provided ID

NoAccessToPickupGroup

Your authenticated identity is not permitted to access this pickup group

ValidationError

A validation error occurred

  • errors

    An array of errors

Response Data

This action will return a pickup group structure.

You'll receive all attributes for this structure (basic and extended attributes). You'll receive all expansions for this stucture.