> ## Documentation Index > Fetch the complete documentation index at: https://docs.tied.com/llms.txt > Use this file to discover all available pages before exploring further. # Add a new custom attribute > Add a new custom attribute to account ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/accounts/{account_id}/custom_attribute_definitions openapi: 3.0.4 info: title: Tied API description: >- The Tied REST API. Three families of endpoint, each with its own credential: **Application** for everything inside an account, **Platform** for provisioning accounts and users, and **Client** for acting as a contact from your own surface. version: 1.1.0 termsOfService: https://tied.com/legal contact: email: hello@tied.com license: name: MIT License url: https://opensource.org/licenses/MIT servers: - url: https://app.tied.com description: Tied cloud security: [] tags: - name: Account AgentBots description: Account-specific Agent Bots - name: Agents description: Agent management APIs - name: Canned Responses description: Pre-defined responses for common queries - name: Contacts description: Contact management APIs - name: Contact Labels description: Manage contact labels - name: Conversation Assignments description: Manage conversation assignments - name: Conversation Labels description: Manage conversation labels - name: Conversations description: Conversation management APIs - name: Custom Attributes description: Custom fields for contacts and conversations - name: Custom Filters description: Saved filters for conversations - name: Inboxes description: Communication channels setup - name: Integrations description: Third-party integrations - name: Messages description: Message management APIs - name: Profile description: User profile APIs - name: Reports description: Analytics and reporting APIs - name: Teams description: Team management APIs - name: Webhooks description: Event notification webhooks - name: Automation Rule description: Workflow automation rules - name: Help Center description: Knowledge base management - name: Contacts API description: Public contact APIs - name: Conversations API description: Public conversation APIs - name: Messages API description: Public message APIs - name: CSAT Survey Page description: Customer satisfaction survey - name: Account description: >- The authenticated user's own account — read and update account settings. Distinct from the Platform family's **Accounts**, which provisions accounts across an installation. - name: Audit Logs description: Read the account's audit trail - name: Inbox API description: Public inbox lookup by channel identifier - name: Labels description: >- Create and manage the account's labels. Applying one to a conversation or contact is a separate endpoint under those resources. - name: Macros description: >- Saved multi-step actions an agent — or an integration — can run against one or more conversations. - name: Campaigns description: Ongoing website campaigns and one-off SMS and WhatsApp sends. - name: Contact Notes description: Internal notes on a contact. Never visible to the contact. - name: Help Center Categories description: Categories group a portal's articles, one tree per allowed locale. - name: Help Center Articles description: The articles a portal publishes, and their draft and archived states. - name: Summary Reports description: Per-agent, per-team, per-inbox and per-label totals for a period, as JSON. - name: Live Reports description: Right-now queue counts. No date range — these describe the present. - name: CSAT description: >- The satisfaction ratings contacts have submitted, and the metrics computed from them. - name: Notifications description: >- The per-user notification feed, its read and snooze state, and the settings that decide what lands in it. - name: Conversation Participants description: >- The agents watching a conversation. Participants get notified about it without being assigned to it. - name: Draft Messages description: >- The unsent reply held for a conversation. Stored in Redis, one per conversation. - name: Search description: >- One search service across conversations, contacts, messages and Help Center articles. - name: Dashboard Apps description: Embedded pages that appear as a tab beside a conversation. - name: Assignment Policies description: How conversations are handed out, and which inbox uses which policy. - name: Files description: Storing a file so another endpoint can attach it. - name: Bot Flows description: >- Scripted conversation flows, their versions, and the publish and rollback that move between them. - name: Billing description: >- Credit balance, usage, invoices, spend controls and the provider-hosted payment flows. - name: AMB Templates description: >- Saved Apple Messages primitive payloads an agent can reuse from the composer. - name: AMB Onboarding description: The in-flight Apple Messages for Business registration for an account. - name: Widget Session description: Starting a widget session and reading the visitor it belongs to. - name: Widget Conversation description: The visitor's conversation and its messages. - name: Widget Context description: Campaigns, agents, labels, events and uploads for a widget session. - name: CSAT Survey description: The public, unauthenticated survey a contact answers from a link. - name: Workspace description: Scheduling and cancelling deletion of the whole workspace. paths: /api/v1/accounts/{account_id}/custom_attribute_definitions: parameters: - $ref: '#/components/parameters/account_id' post: tags: - Custom Attributes summary: Add a new custom attribute description: Add a new custom attribute to account operationId: add-new-custom-attribute-to-account requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/custom_attribute_create_update_payload' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/custom_attribute' example: id: 25 attribute_display_name: Renewal date attribute_display_type: date attribute_description: When the contract renews attribute_key: renewal_date_112426 regex_pattern: null regex_cue: null attribute_values: [] attribute_model: contact_attribute default_value: null created_at: '2026-09-21T02:24:17.078Z' updated_at: '2026-09-21T02:24:17.078Z' '403': description: Access denied content: application/json: schema: $ref: '#/components/schemas/error_message' security: - userApiKey: [] components: parameters: account_id: in: path name: id schema: type: integer required: true description: The numeric ID of the account schemas: custom_attribute_create_update_payload: type: object properties: attribute_display_name: type: string description: Attribute display name example: Custom Attribute attribute_display_type: type: integer description: >- Attribute display type (text- 0, number- 1, currency- 2, percent- 3, link- 4, date- 5, list- 6, checkbox- 7) example: 0 attribute_description: type: string description: Attribute description example: This is a custom attribute attribute_key: type: string description: Attribute unique key value example: custom_attribute attribute_values: type: array description: Attribute values items: type: string example: - value1 - value2 attribute_model: type: integer description: Attribute type(conversation_attribute- 0, contact_attribute- 1) example: 0 regex_pattern: type: string description: >- Regex pattern (Only applicable for type- text). The regex pattern is used to validate the attribute value(s). example: ^[a-zA-Z0-9]+$ regex_cue: type: string description: >- Regex cue message (Only applicable for type- text). The cue message is shown when the regex pattern is not matched. example: Please enter a valid value custom_attribute: type: object properties: id: type: integer description: Identifier attribute_display_name: type: string description: Attribute display name attribute_display_type: type: string description: >- Attribute display type (text, number, currency, percent, link, date, list, checkbox) attribute_description: type: string description: Attribute description nullable: true attribute_key: type: string description: Attribute unique key value regex_pattern: type: string description: Regex pattern nullable: true regex_cue: type: string description: Regex cue nullable: true attribute_values: type: array description: >- Allowed values when `attribute_display_type` is `list`. Empty array for other types. items: type: string attribute_model: type: string description: Attribute type(conversation_attribute/contact_attribute) default_value: type: string description: Attribute default value nullable: true created_at: type: string description: The date and time when the custom attribute was created updated_at: type: string description: The date and time when the custom attribute was updated error_message: type: object description: >- The shape returned by `render_unauthorized`, `render_not_found_error` and `render_could_not_create_error`. properties: error: type: string description: A single human-readable message. example: Resource could not be found required: - error securitySchemes: userApiKey: type: apiKey in: header name: api_access_token description: >- This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.