Sign in

Update a property definition

Patches the editable fields (name, icon, enabled) of a property definition. type and scoping fields are immutable; type must be supplied in the body so the server knows which per-type table to write.

patch/v2/prism/{teamId}/action/properties/{propertyId}

Path parameters

teamIdstring uuid required
propertyIdstring uuid required

Headers

Idempotency-Keystring

A unique key (UUID or any opaque string up to 255 chars) for an authenticated POST, PUT, or PATCH request. The server retains the initial claim for 24 hours and replays a completed non-5xx response only when the method, path, and request body all match. Reusing a non-expired key with a different method, path, or body returns 409 idempotency_key_mismatch; reusing it after expiry returns 409 idempotency_key_stale, so use a new key. Replays include the idempotent-replay: true response header.

Request body

type'num' | 'str' | 'bool' | 'date' | 'text' | 'byte' | 'select_str' | 'multi_str' | 'multiselect_str' | 'jsonb' | 'ref_identity' | 'ref_user' | 'ref_organization' | 'ref_contact' | 'ref_thread' | 'ref_message' | 'ref_event' | 'ref_account' | 'ref_ai_chat_thread' | 'ref_ai_chat_message' | 'multiref_ai_chat_message' | 'multiref_agent_site' | 'multiref_action' | 'multiref_comment' | 'multiref_contact' | 'multiref_label' | 'multiref_thread' | 'multiref_messages' | 'multiref_document' | 'multiref_identity' | 'multiref_organization' | 'multiref_engagement' | 'multiref_attendee' | 'multiref_meeting_entry' | 'multiref_read_receipt' | 'multiref_account' | 'multiref_source' required

Storage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.

list_idstring uuid nullable
namestring
iconstring nullable
enabledboolean
requiredboolean

Response

Property updated

idstring uuid required
slugstring required
namestring nullable
type'num' | 'str' | 'bool' | 'date' | 'text' | 'byte' | 'select_str' | 'multi_str' | 'multiselect_str' | 'jsonb' | 'ref_identity' | 'ref_user' | 'ref_organization' | 'ref_contact' | 'ref_thread' | 'ref_message' | 'ref_event' | 'ref_account' | 'ref_ai_chat_thread' | 'ref_ai_chat_message' | 'multiref_ai_chat_message' | 'multiref_agent_site' | 'multiref_action' | 'multiref_comment' | 'multiref_contact' | 'multiref_label' | 'multiref_thread' | 'multiref_messages' | 'multiref_document' | 'multiref_identity' | 'multiref_organization' | 'multiref_engagement' | 'multiref_attendee' | 'multiref_meeting_entry' | 'multiref_read_receipt' | 'multiref_account' | 'multiref_source' required

Storage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.

team_idstring uuid nullable
crm_idstring uuid nullable

Identifier of the list this definition is scoped to, when applicable.

list_idstring uuid nullable

Canonical identifier of the list this definition is scoped to.

nativeboolean
lockedboolean
alias'app_stage' | 'null' nullable

Reserved alias naming this definition, or null. app_stage marks the list pipeline stage definition. Resolve stages by this field rather than by name, slug, or team_id: a superseded native status definition can coexist with the pipeline one and is otherwise identical on the wire.

requiredboolean

When true, records of this object type must carry a non-empty value for this property on create, and a patch may not clear it.

role_idstring uuid nullable

The property's display format. Always populated on definitions created through this API; a null here means the definition predates that and will render as an unknown format until it is patched.

Changes

Changed in 7 of the 29 revisions of this API.3619

  • 558afa74332e112See the full diff
    • ▲

      removed the enum value multiref_agent_artifact of the request property type

      request-property-enum-value-removed

    • ●

      added the new multiref_agent_site enum value to the type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new multiref_agent_site enum value to the request property type

      request-property-enum-value-added

    • ○

      removed the multiref_agent_artifact enum value from the type response property for the response status 200

      response-property-enum-value-removed

  • aa8d5fd72a2b29See the full diff
    • ▲

      removed the enum value multiref_organization_user of the request property type

      request-property-enum-value-removed

    • ▲

      removed the enum value ref_organization_user of the request property type

      request-property-enum-value-removed

    • ○

      added the optional property alias to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property list_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property locked to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property native to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property options/items/crm_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property options/items/list_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property role_id to the response with the 200 status

      response-optional-property-added

    • ○

      removed the multiref_organization_user enum value from the type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ref_organization_user enum value from the type response property for the response status 200

      response-property-enum-value-removed

  • c80d4cd98e862See the full diff
    • ○

      added the new optional request property required

      new-optional-request-property

    • ○

      added the optional property required to the response with the 200 status

      response-optional-property-added

  • 1b424132b17611See the full diff
    • ●

      added the new multiref_source enum value to the type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new multiref_source enum value to the request property type

      request-property-enum-value-added

  • 972de9ac2d5033See the full diff
    • ●

      added the new multiref_agent_artifact enum value to the type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ref_ai_chat_message enum value to the type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ref_ai_chat_thread enum value to the type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new multiref_agent_artifact enum value to the request property type

      request-property-enum-value-added

    • ○

      added the new ref_ai_chat_message enum value to the request property type

      request-property-enum-value-added

    • ○

      added the new ref_ai_chat_thread enum value to the request property type

      request-property-enum-value-added

  • b9a4e962de7011See the full diff
    • ●

      added the new multiref_comment enum value to the type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new multiref_comment enum value to the request property type

      request-property-enum-value-added

  • 9a99c0de89ed1See the full diff
    • ○

      endpoint added

      endpoint-added