Skip to content

Add a collaborator to an app

POST
/v1/apps/{appName}/collaborators
curl --request POST \
--url https://api.aetherpush.com/v1/apps/example/collaborators \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "email": "bob@example.com" }'

Adds an existing Aether account as a collaborator on the app. Requires the collaborators.manage permission (Owner or Admin). The target account must already be registered.

appName
required
string
Media typeapplication/json
object
email
required

Email of the account to add as collaborator.

string format: email
permission

Role to grant. Defaults to Developer when omitted. Owner can only be granted through an ownership transfer.

string
Allowed values: Admin Developer Viewer
Example
{
"email": "bob@example.com"
}

Collaborator added.

Email missing or invalid.

Media typeapplication/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"
}

Insufficient permissions (collaborators.manage required).

Media typeapplication/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"
}

App not found, or target account does not exist.

Media typeapplication/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"
}

The account is already a collaborator on this app.

Media typeapplication/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"
}