Updating Cards

API Endpoint

PUT /v1/cards/{cardId}/extended

URL Parameters

  • cardId the ID of the card, which will be of the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

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

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. NOTE - If this field is missing, existing collaborators will NOT be removed from the card
  • collaborators For cards that have a shareStatus of PRIVATE, the collaborators can be used to give specific users access to the card. NOTE - If this field is missing, existing collaborators will NOT be removed from 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. NOTE - If a tag is on a card but not listed in this array on an updated, that tag will be removed from the card
  • 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. If this field is missing, the verifier will not be changed. 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
{
  "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"
  }]
}

Response

The response will include all content sent in the request.

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"
  }]
}