Skip to main content
POST
Create card

Authorizations

Authorization
string
header
required

API token in the sk_live_… format.

Body

application/json
name
string
required

Card name.

Example:

"Pedido #88213"

crmBoardId
integer
required

CRM board.

Example:

7

crmBoardListId
integer
required

Board stage where the card is created.

Example:

31

description
string

Card description.

origin
string

Card origin, given by name. If it does not exist yet, it is created.

Example:

"Instagram"

assignedToUserId
integer

Agent in charge of the card. Use the user's id in this company, the same one GET /users returns. The same person has a different id in each company they work for.

Example:

3

crmBusinessId
integer

Business linked to the card.

Example:

9

crmBoardCardStatusId
integer

Only cards with this status. Statuses are configured on each stage.

Example:

2

customFields
object[]

CRM custom fields to save on the new card. If any value fails the field type validation, the response is 400 and the card is not created.

products
object[]

Products on the card. Each item points to a product already registered in the catalog. The API does not create new products here.

Response

Created. Returns the full card, with contacts, customFields and products, including those sent in this request. You do not need to make a GET right after the POST.

data
object

A card on a CRM board. The response includes only the fields listed here.

Example: