custom-fields

Create a custom field

Changed on

Creates a new custom field definition for the specified object type.

Rate limit: 120 requests per minute

post/custom-fields

Request

  • Base URL
    https://api.usepylon.com
  • URL
    https://api.usepylon.com/custom-fields
  • Auth
    HTTP bearer

Request body

default_valuestring

The default value for single-valued custom fields.

default_valuesstring[]

The default values for multi-valued custom fields.

descriptionstring

The description of the custom field.

labelstring required

The label of the custom field.

object_type'account' | 'issue' | 'contact' | 'task' | 'project' | 'meeting' | 'opportunity' required

The object type of the custom field. Can be "account", "issue", "contact", "task", "project", "meeting", or "opportunity".

slugstring

The slug of the custom field.

typestring required

The type of the custom field. Can be one of text, number, decimal, boolean, date, datetime, user, url, select, or multiselect.

Example request

{
  "object_type": "account",
  "type": "text"
}

Response

request_idstring required

The request ID for tracking.

Example response

{
  "data": {
    "object_type": "account",
    "type": "text"
  }
}

Changes

    • info

      the response property became required for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      removed the currency enum value from the // response property for the response status

    • info

      removed the duplicate_object enum value from the response property for the response status

    • info

      removed the duplicate_object enum value from the response property for the response status

    • info

      removed the duplicate_object enum value from the response property for the response status

    • info

      removed the duplicate_object enum value from the response property for the response status

    • info

      removed the duration enum value from the // response property for the response status

    • info

      removed the email_bounced enum value from the response property for the response status

    • info

      removed the email_bounced enum value from the response property for the response status

    • info

      removed the email_bounced enum value from the response property for the response status

    • info

      removed the email_bounced enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_issue_reply_not_allowed enum value from the response property for the response status

    • info

      removed the internal_issue_reply_not_allowed enum value from the response property for the response status

    • info

      removed the internal_issue_reply_not_allowed enum value from the response property for the response status

    • info

      removed the internal_issue_reply_not_allowed enum value from the response property for the response status

    • info

      removed the invalid_api_token enum value from the response property for the response status

    • info

      removed the invalid_api_token enum value from the response property for the response status

    • info

      removed the invalid_api_token enum value from the response property for the response status

    • info

      removed the invalid_api_token enum value from the response property for the response status

    • info

      removed the invalid_authorization_header enum value from the response property for the response status

    • info

      removed the invalid_authorization_header enum value from the response property for the response status

    • info

      removed the invalid_authorization_header enum value from the response property for the response status

    • info

      removed the invalid_authorization_header enum value from the response property for the response status

    • info

      removed the invalid_oauth_token enum value from the response property for the response status

    • info

      removed the invalid_oauth_token enum value from the response property for the response status

    • info

      removed the invalid_oauth_token enum value from the response property for the response status

    • info

      removed the invalid_oauth_token enum value from the response property for the response status

    • info

      removed the invalid_request_body enum value from the response property for the response status

    • info

      removed the invalid_request_body enum value from the response property for the response status

    • info

      removed the invalid_request_body enum value from the response property for the response status

    • info

      removed the invalid_request_body enum value from the response property for the response status

    • info

      removed the invalid_webhook_credentials enum value from the response property for the response status

    • info

      removed the invalid_webhook_credentials enum value from the response property for the response status

    • info

      removed the invalid_webhook_credentials enum value from the response property for the response status

    • info

      removed the invalid_webhook_credentials enum value from the response property for the response status

    • info

      removed the method_not_allowed enum value from the response property for the response status

    • info

      removed the method_not_allowed enum value from the response property for the response status

    • info

      removed the method_not_allowed enum value from the response property for the response status

    • info

      removed the method_not_allowed enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the oauth_not_permitted enum value from the response property for the response status

    • info

      removed the oauth_not_permitted enum value from the response property for the response status

    • info

      removed the oauth_not_permitted enum value from the response property for the response status

    • info

      removed the oauth_not_permitted enum value from the response property for the response status

    • info

      removed the organization_deactivated enum value from the response property for the response status

    • info

      removed the organization_deactivated enum value from the response property for the response status

    • info

      removed the organization_deactivated enum value from the response property for the response status

    • info

      removed the organization_deactivated enum value from the response property for the response status

    • info

      removed the organization_inactive enum value from the response property for the response status

    • info

      removed the organization_inactive enum value from the response property for the response status

    • info

      removed the organization_inactive enum value from the response property for the response status

    • info

      removed the organization_inactive enum value from the response property for the response status

    • info

      removed the organization_suspended enum value from the response property for the response status

    • info

      removed the organization_suspended enum value from the response property for the response status

    • info

      removed the organization_suspended enum value from the response property for the response status

    • info

      removed the organization_suspended enum value from the response property for the response status

    • info

      removed the payload_too_large enum value from the response property for the response status

    • info

      removed the payload_too_large enum value from the response property for the response status

    • info

      removed the payload_too_large enum value from the response property for the response status

    • info

      removed the payload_too_large enum value from the response property for the response status

    • info

      removed the percent enum value from the // response property for the response status

    • info

      removed the permission_denied enum value from the response property for the response status

    • info

      removed the permission_denied enum value from the response property for the response status

    • info

      removed the permission_denied enum value from the response property for the response status

    • info

      removed the permission_denied enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the recipients_suppressed enum value from the response property for the response status

    • info

      removed the recipients_suppressed enum value from the response property for the response status

    • info

      removed the recipients_suppressed enum value from the response property for the response status

    • info

      removed the recipients_suppressed enum value from the response property for the response status

    • info

      removed the with_commas enum value from the // response property for the response status

    • info

      removed the wrong_region_token enum value from the response property for the response status

    • info

      removed the wrong_region_token enum value from the response property for the response status

    • info

      removed the wrong_region_token enum value from the response property for the response status

    • info

      removed the wrong_region_token enum value from the response property for the response status