Activate the installation for a client

The integration sends a request to this endpoint to activate the installation, post authorisation. The request is sent after the integration has synchronised tags, tax codes, and vendors between the Pleo account and the client. Note that this is applicable when OAuth is used for authorisation.

POST /v1/installations/me:activate

Activate the installation for a client

cURL

curl --request POST \
  --url https://external.pleo.io/v1/installations/me:activate \
  --header 'Authorization: Bearer <token>'

200

{
  "applicationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2021-01-01T00:00:00Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {
    "key": "value"
  },
  "resource": "urn:pleo:company:123e4567-e89b-12d3-a456-426614174000",
  "status": "ACTIVATED",
  "updatedAt": "2021-01-01T00:00:00Z",
  "errorCode": "NOT_ENTITLED"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json;charset=UTF-8

Installation is successfully activated.

applicationId · string<uuid> · required

The unique identifier of the application this installation is for.

Example:

"123e4567-e89b-12d3-a456-426614174000"

createdAt · string<date-time> · required

The date and time when the installation was created.

Example:

"2021-01-01T00:00:00Z"

id · string<uuid> · required

The unique identifier of the installation.

Example:

"123e4567-e89b-12d3-a456-426614174000"

metadata · object · required

Additional information about the installation.

Show child attributes

Example:

{ "key": "value" }

resource · string · required

The resource that the installation is for.

Example:

"urn:pleo:company:123e4567-e89b-12d3-a456-426614174000"

status · enum<string> · required

Available options: ACTIVATED, INACTIVE, AUTHORIZED, PENDING_INTEGRATION

updatedAt · string<date-time> · required

The date and time when the installation was last updated.

Example:

"2021-01-01T00:00:00Z"

errorCode · string

Explains the error that inactivated the installation. This appear if the installation status is inactive.

Example:

"NOT_ENTITLED"