Remove a collaborator from an app

DELETE

/v1/apps/{appName}/collaborators/{email}

const url = 'https://api.aetherpush.com/v1/apps/example/collaborators/hello%40example.com';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.aetherpush.com/v1/apps/example/collaborators/hello%40example.com \
  --header 'Authorization: Bearer <token>'

Removes a collaborator from the app. Accounts with the collaborators.manage permission (Owner or Admin) can remove any non-owner collaborator; every collaborator can remove themselves (self-leave).

Authorizations

accessKeyAuth
apiKeyAuth
apps

Parameters

Path Parameters

appName

required

string

email

required

string format: email

Responses

204

Collaborator removed.

400

Invalid email parameter.

application/json

object

error

required

Human-readable error message.

string

requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}

403

Insufficient permissions (collaborators.manage required unless removing yourself).

application/json

object

error

required

Human-readable error message.

string

requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}

404

App not found, or target email is not a collaborator.

application/json

object

error

required

Human-readable error message.

string

requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}

409

The target is the owner, who cannot be removed.

application/json

object

error

required

Human-readable error message.

string

requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}