Create or update a card
Creates a new card on the board. Use field UUIDs (from the schema endpoint) as keys in the request body.
To update an existing card, include its _id in the request body. The card must belong to this board. Fields not provided in the body are left unchanged on update.
Contact fields take person ids from the Contacts API: a person field takes { "_id": "<personId>" } (or null to clear it), and a persons field takes an array of them ([] clears it). Each id must be an existing contact in the board's company. The stored value is expanded to { _id, name, duogram }, where name is the contact's full name and duogram its initials; any other keys sent are ignored.
Card-link fields (location, unit, relatedAptlets) always take an array of { "_id": "<cardId>" } ([] clears the field). Each id must be a live (non-archived) card in the board's company that matches every part of the field's filter that is set: the card must be on one of the boards in filter.aptletUuids, and its board's type must be in filter.aptletTypes. location and unit fields with no aptletUuids take cards from the built-in location and unit boards. Values are stored as { _id, name, duogram }.
Request
- Base URLhttps://core-api.getaptly.com
- Auth
- API key in header x-token
- or API key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Request body
Response
Card created.
Changes
No recorded changes to this operation across all 1 revision of this API.