Skip to content
Optiwork API Docs

Delete a distribution list

DELETE
/groups/distribution-list
curl --request DELETE \
  --url https://calendar.work.optidata.cloud/api/groups/distribution-list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "zid": "5a1c1f7e-9f2d-4a6b-8a30-1c0d9d2f4b11", "email": "engineering@acme.example" }'

Removes a distribution list. Both zid and email are required and must identify the same list.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
zid
required

Identifier of the list.

string
<= 255 characters
email
required

Address of the list.

string format: email
<= 255 characters
Examples
Exampledelete
{
  "zid": "5a1c1f7e-9f2d-4a6b-8a30-1c0d9d2f4b11",
  "email": "engineering@acme.example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

The distribution list was deleted.

Media typeapplication/json

Acknowledgement returned by several write operations.

object
message
required
string
Examples
Exampledeleted
{
  "message": "Distribution list deleted successfully"
}

401

Section titled “401”

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

422

Section titled “422”

The request body or query string failed validation.

Media typeapplication/json
object
message
required

The first validation message.

string
errors
required

Validation messages keyed by field name.

object
key
additional properties
Array<string>
Examples
Exampleinvalid
{
  "message": "The event title field is required.",
  "errors": {
    "title": [
      "The event title field is required."
    ]
  }
}

429

Section titled “429”

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
  "message": "Too Many Attempts."
}