Creating Cards

API Endpoint

POST /v1/cards/extended

Request Headers

Along with a appropriate authentication headers, you must provide a Content-Type header with a value of application/json

Request Body

Required Fields

  • preferredPhrase the title of the card
  • content the content of the card
  • shareStatus the visibility setting for the card. Acceptable values are TEAM, PRIVATE, and PUBLIC. More information on these sharing settings can be found here.
  • collection the ID of the collection that the card should be created in

Other Fields

  • verificationInterval the frequency (in days) that this card needs to be verified. Acceptable values are 7, 14, 30, 90 180, 365. If no value is specified, the verification interval will default to 90 days
  • boards The boards to add this card to.
  • collaborators For cards that have a shareStatus of PRIVATE, the collaborators can be used to give specific users access to the card.
  • tags The tags to be added to the new card. To get a list of available Tags, see the documentation on listing tag categories
  • verifiers The user or group that is responsible for verifying this card. This field is an array, but only one value may be specified in the array. To specify a user as the verifier, specify a user object with a type of user and with the user's email address
{
  "type" : "user",
  "user" : {
    "email" : "user@email.com"
  }
}

To specify a group as a verifier, specify a group object with a type of user-group and with the group's ID...

{
  "type" : "user-group",
  "userGroup" : {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  }
}
Sample Request
{
  "preferredPhrase": "What is Guru",
  "content": "Instant access to the knowledge your team needs to do its job, everywhere it's done. Move faster and more confidently, together.",
  "verificationInterval": 90,
  "shareStatus": "TEAM",
  "collection" : { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" },
  "boards": [{"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}],
  "collaborators": [{
    "user": {
      "email": "user@email.com"
    },
    "type": "user"
  }],
  "tags" : [{
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  }],
  "verifiers": [{
    "user": {
      "email": "user@email.com"
    },
    "type": "user"
  }]
}

Response

The response will include all content sent in along with the card's id.

Sample Response
{
  "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "preferredPhrase": "What is Guru",
  "content": "Instant access to the knowledge your team needs to do its job, everywhere it's done. Move faster and more confidently, together.",
  "verificationInterval": 90,
  "shareStatus": "TEAM",
  "boards": [{"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}],
  "collaborators": [{
    "user": {
      "email": "user@email.com"
    },
    "type": "user"
  }],
  "tags" : [{
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  }],
  "verifiers": [{
    "user": {
      "email": "user@email.com"
    },
    "type": "user"
  }]
}