Create insight label – ConversionLab Docs

POST /insight-labels

Create insight label. Requires the REST write token ability. The bearer token selects the Team; a supplied team_id cannot switch tenants. Additional role, entity-policy and plan requirements vary by operation. A Team in blocked billing mode cannot write and receives 402.

Authentication

Use a team API key as Authorization: Bearer YOUR_API_KEY. The token ability and the user’s role must both allow this operation. See authentication.

{
  "ability": "write",
  "team": "Token-bound Team",
  "authorization": "Additional role, entity-policy and plan requirements vary by operation.",
  "billing": "Blocked billing mode rejects writes with 402."
}

Request body

A request body is required.

application/json

{
  "type": "object",
  "properties": {
    "project_id": {
      "type": "integer"
    },
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "color": {
      "type": "string",
      "enum": [
        "gray",
        "red",
        "orange",
        "green",
        "blue",
        "purple",
        "rose"
      ],
      "title": "InsightLabelColor"
    }
  },
  "required": [
    "project_id",
    "name",
    "color"
  ],
  "title": "StoreInsightLabelRequest"
}

{
  "project_id": 101,
  "name": "Checkout delivery estimate",
  "color": "gray"
}

Example request

curl --request POST 'https://api.example.test/api/insight-labels' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"project_id":101,"name":"Checkout delivery estimate","color":"gray"}'

Examples use fictional data. Replace resource IDs and the API host with your environment’s values.

Responses

200

InsightLabelResource

Content type: application/json.

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "project_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "color": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "gray",
                "red",
                "orange",
                "green",
                "blue",
                "purple",
                "rose"
              ],
              "title": "InsightLabelColor"
            },
            {
              "type": "null"
            }
          ]
        },
        "order": {
          "type": [
            "integer",
            "null"
          ]
        },
        "created_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updated_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "deleted_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "required": [
        "id",
        "project_id",
        "name",
        "color",
        "order",
        "created_at",
        "updated_at",
        "deleted_at"
      ],
      "title": "InsightLabelResource"
    }
  },
  "required": [
    "data"
  ]
}

{
  "data": {
    "id": 101,
    "project_id": null,
    "name": null,
    "color": null,
    "order": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null
  }
}

401

Unauthenticated

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "The request could not be completed."
}

402

The Team is in read-only billing mode.

Content type: application/json.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "const": "subscription_required"
    },
    "mode": {
      "type": "string",
      "const": "blocked"
    },
    "message": {
      "type": "string",
      "example": "Your team is in read-only mode. Update billing to make changes."
    },
    "grace_period_ends_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  },
  "required": [
    "error",
    "mode",
    "message",
    "grace_period_ends_at"
  ]
}

{
  "error": "subscription_required",
  "mode": "blocked",
  "message": "Your team is in read-only mode. Update billing to make changes.",
  "grace_period_ends_at": null
}

403

Authorization error

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "The request could not be completed."
}

422

Validation error

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Errors overview."
    },
    "errors": {
      "type": "object",
      "description": "A detailed description of each field that failed validation.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "message",
    "errors"
  ]
}

{
  "message": "The request could not be completed.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

429

Rate limit exceeded. Honor Retry-After before retrying.

Response headers:

{
  "Retry-After": {
    "description": "Seconds before retrying.",
    "schema": {
      "type": "integer"
    }
  }
}

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Too Many Attempts."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "Too Many Attempts."
}

See API conventions for error handling, rate limits, pagination, and uploads.

On this page