Create a new pickup group

This action will create a new pickup group in the given unit.

Try this request in your browser

/api/ /pickup_groups/create

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

unit_id Integer
name String 

The request output will be shown here...

URL

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

Access

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

Parameters

Parameter Type Default

unit_id

The ID of the unit

 Integer null

name

The name

 String null

Errors

Error Attributes

UnitNotFound

The given unit was not found

  • id

    The provided ID

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.