Install your app on a company or syndicate

POST 
/installations

Installs the calling application on a company or syndicate the token's user can edit (or, for a syndicate, manages), and mints the company-owned token the install stands for. The token appears in this response only. Requires a token authorized by a user.

The install is granted at the caller's tier (founder, admin or editor for a company). An editor-tier install carries read scopes only; write scopes in scopes are dropped. Installing on a company outside your own organization requires the app to be approved.

Request

Responses

201

The new installation and its token (shown once)

401

Authentication required or token is invalid/expired. This error occurs when:

• No Authorization header is provided
• The access token is invalid or malformed
• The access token has expired
• The access token has been revoked

To resolve: Obtain a new access token using the OAuth 2.0 flow.

403

The authenticated user does not have permission to access this resource. This typically means:

• The user is authenticated but lacks the required OAuth scope
• The resource belongs to a different user
• The user's role doesn't allow this operation

Check that your OAuth token includes the necessary scopes for this endpoint.

404

The requested resource does not exist or is not visible to this token.

409

Already installed here; error.details.installation is the existing install's id.

422

Unknown target_type, or none of the requested scopes can be granted by the caller's role.