Skip to main content

Deprecations

This section lists all endpoints and methods which are currently in a deprecation period.

tip

Stay in the loop! If you'd like to receive email notifications regarding updates to our API, we encourage you to subscribe to our developer newsletter. Note: By subscribing, you agree to receive periodic emails from us. We respect your privacy and won't share your information with third parties. You can unsubscribe at any time.

Deprecation of member filter in the fetch cards endpoint

The member_id query parameter of GET /cards is being deprecated in favor of the user_id parameter.

For more information, read the API documentation for this endpoint: https://api.kisi.io/docs#/operations/fetchCards.

Sunset date

The sunset date is March 31, 2024. Please make sure to update any code calling the affected endpoints before this date.

Deprecation of presence endpoint properties

The member_id, member_name, user_id, user_name and user_email fields are being deprecated. They are replaced now by the fields actor_type, actor_id, actor_name and actor_email. During the deprecation phase we will only return User as actor_type. After finalizing the deprecation we will start returning GroupLink as actor_type too.

For more information, read the API documentation for this endpoint: https://api.kisi.io/docs#/operations/fetchPresences.

Sunset date

The sunset date is January 15, 2024. Please make sure to update any code calling the affected endpoints before this date.

Deprecation of member assignment to cards

The member assignment to cards feature is being deprecated. This change impacts several endpoints associated with the deprecation:

  • POST /cards/:id/assign_member: this endpoint is being removed and replaced in favor of POST /cards/:id/assign. The event also changes from member.assign_card to card.assign. For more information about how the endpoint works read: https://api.kisi.io/docs/#/operations/assignCard.
  • POST /cards/:id/deassign_member: this endpoint is being removed and replaced in favor of POST /cards/:id/deassign. The event also changes from member.deassign_card to card.assign. For more information about how the endpoint works read: https://api.kisi.io/docs/#/operations/deassignCard.
  • GET /cards/:id: the properties member_assigned and member are deprecated.
  • POST /members/:id/assign_card: this endpoint is being removed and replaced by POST /cards/:id/assign. The event also changes from member.assign_card to card.assign. For more information about how the endpoint works read: https://api.kisi.io/docs/#/operations/assignCard.
  • POST /members/:id/assign_backup_card: this endpoint is being removed and replaced by POST /cards/:id/assign. We no longer support assigning specific cards as backup. We now assign the card as backup automatically depending on the cards the user already has. The event also changes from member.assign_backup_card to card.assign. For more information about how the endpoint works read: https://api.kisi.io/docs/#/operations/assignCard.
  • POST /members/:id/deassign_card: this endpoint is being removed and replaced by POST /cards/:id/deassign. The event also changes from member.deassign_card to card.deassign. For more information about how the endpoint works read: https://api.kisi.io/docs/#/operations/deassignCard.
  • POST /members/:id/deassign_backup_card: this endpoint is being removed and replaced by POST /cards/:id/deassign. The event also changes from member.deassign_backup_card to card.deassign. For more information about how the endpoint works read: https://api.kisi.io/docs/#/operations/deassignCard.
  • GET /members/:id and GET /members: the properties cards_count, card_assigned, card_assigned_at, backup_card_assignes, backup_card_assigned_at, card_id, card_assigned_by_id, backup_card_id, backup_card_assigned_by_id, backup_card, card, card_assigned_by, backup_card_assigned_by are deprecated.

Sunset date

The sunset date for the above mentioned endpoints is December 31, 2023. Please make sure to update any code calling the affected endpoint before this date.

Deprecation of events endpoint

The GET /events endpoint is being deprecated in favor of two new endpoints: POST /event_sets and GET /event_sets/{id}.

To ensure a smooth transition, please refer to our updated documentation at the following links:

Note

Event endpoints have stricter rate limits than other endpoints. Whenever possible, we recommend using webhooks instead of relying on polling with API calls. This ensures real-time updates and reduces the risk of hitting rate limits.

Sunset date

The sunset date of the GET /events endpoint is December 31, 2023. We kindly ask you to make the necessary adjustments to your codebase well in advance to prevent any disruptions to your application.