Create a client installation
The integration sends a request to this endpoint to create an installation. This is required, especially when API keys are used for authorisation.
Authorizations
JWT Bearer token authentication. Include the token in the Authorization header as: Bearer <token>
Body
Installation request
Metadata associated with the installation. This can be used to store additional information about the installation, for example external references, but it is not used by any Pleo system.
ACTIVATED, INACTIVE, AUTHORIZED, PENDING_INTEGRATION, ERROR Response
Installation created.
The unique identifier of the application this installation is for.
"123e4567-e89b-12d3-a456-426614174000"
The date and time when the installation was created.
"2021-01-01T00:00:00Z"
The unique identifier of the installation.
"123e4567-e89b-12d3-a456-426614174000"
Additional information about the installation.
The resource that the installation is for.
"urn:pleo:company:123e4567-e89b-12d3-a456-426614174000"
This can be one of InstallationStatus values
"ACTIVATED"
The date and time when the installation was last updated.
"2021-01-01T00:00:00Z"
Explains the error that inactivated the installation. This appear if the installation status is inactive.
"NOT_ENTITLED"