Remove a pickup group

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

Try this request in your browser

/api/ /pickup_groups/destroy

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 

The request output will be shown here...

URL

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

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

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

Response Data

This action will return a Boolean.