Asana
  1. Projects
Asana
  • Attachments
    • Delete an attachment
      DELETE
    • Get an attachment
      GET
    • Get attachments for a task
      GET
    • Upload an attachment
      POST
  • Batch API
    • Submit parallel requests
      POST
  • Custom Fields
    • Create a custom field
      POST
    • Delete a custom field
      DELETE
    • Get a custom field
      GET
    • Update a custom field
      PUT
    • Create an enum option
      POST
    • Reorder a custom field's enum
      POST
    • Update an enum option
      PUT
    • Get a workspace's custom fields
      GET
  • Events
    • Get events on a resource
  • Goals
    • Get goals
    • Create a goal
    • Delete a goal
    • Get a goal
    • Update a goal
    • Add a collaborator to a goal
    • Add a subgoal to a parent goal
    • Add a project/portfolio as supporting work for a goal.
    • Get parent goals from a goal
    • Remove a collaborator from a goal
    • Remove a subgoal from a goal
    • Remove a project/portfolio as supporting work for a goal.
    • Create a goal metric
    • Update a goal metric
    • Get subgoals from a goal
    • Get supporting work from a goal
  • Jobs
    • Get a job by id
  • Organization Exports
    • Create an organization export request
    • Get details on an org export request
  • Teams
    • Get teams in an organization
    • Create a team
    • Get a team
    • Add a user to a team
    • Remove a user from a team
    • Get teams for a user
  • Portfolio Memberships
    • Get multiple portfolio memberships
    • Get a portfolio membership
    • Get memberships from a portfolio
  • Portfolios
    • Get multiple portfolios
    • Create a portfolio
    • Delete a portfolio
    • Get a portfolio
    • Update a portfolio
    • Add a custom field to a portfolio
    • Add a portfolio item
    • Add users to a portfolio
    • Get portfolio items
    • Remove a custom field from a portfolio
    • Remove a portfolio item
    • Remove users from a portfolio
  • Custom Field Settings
    • Get a portfolio's custom fields
    • Get a project's custom fields
  • Project Memberships
    • Get a project membership
    • Get memberships from a project
  • Project Statuses
    • Delete a project status
    • Get a project status
    • Get statuses from a project
    • Create a project status
  • Projects
    • Get multiple projects
      GET
    • Create a project
      POST
    • Delete a project
      DELETE
    • Get a project
      GET
    • Update a project
      PUT
    • Add a custom field to a project
      POST
    • Add followers to a project
      POST
    • Add users to a project
      POST
    • Duplicate a project
      POST
    • Remove a custom field from a project
      POST
    • Remove followers from a project
      POST
    • Remove users from a project
      POST
    • Get task count of a project
      GET
    • Get projects a task is in
      GET
    • Get a team's projects
      GET
    • Create a project in a team
      POST
    • Get all projects in a workspace
      GET
    • Create a project in a workspace
      POST
  • Sections
    • Get sections in a project
    • Create a section in a project
    • Move or Insert sections
    • Delete a section
    • Get a section
    • Update a section
    • Add task to section
  • Tasks
    • Get tasks from a project
    • Get tasks from a section
    • Get tasks from a tag
    • Get multiple tasks
    • Create a task
    • Delete a task
    • Get a task
    • Update a task
    • Set dependencies for a task
    • Set dependents for a task
    • Add followers to a task
    • Add a project to a task
    • Add a tag to a task
    • Get dependencies from a task
    • Get dependents from a task
    • Duplicate a task
    • Unlink dependencies from a task
    • Unlink dependents from a task
    • Remove followers from a task
    • Remove a project from a task
    • Remove a tag from a task
    • Set the parent of a task
    • Get subtasks from a task
    • Create a subtask
    • Get tasks from a user task list
    • Search tasks in a workspace
  • Stories
    • Delete a story
    • Get a story
    • Update a story
    • Get stories from a task
    • Create a story on a task
  • Tags
    • Get multiple tags
    • Create a tag
    • Delete a tag
    • Get a tag
    • Update a tag
    • Get a task's tags
    • Get tags in a workspace
    • Create a tag in a workspace
  • Team Memberships
    • Get team memberships
    • Get a team membership
    • Get memberships from a team
    • Get memberships from a user
  • Users
    • Get users in a team
    • Get multiple users
    • Get a user
    • Get a user's favorites
    • Get users in a workspace or organization
  • Time Periods
    • Get time periods
    • Get a time period
  • User Task Lists
    • Get a user task list
    • Get a user's task list
  • Workspace Memberships
    • Get workspace memberships for a user
    • Get a workspace membership
    • Get the workspace memberships for a workspace
  • Webhooks
    • Get multiple webhooks
    • Establish a webhook
    • Delete a webhook
    • Get a webhook
  • Workspaces
    • Get multiple workspaces
    • Get a workspace
    • Update a workspace
    • Add a user to a workspace or organization
    • Remove a user from a workspace or organization
  • Typeahead
    • Get objects via typeahead
  1. Projects

Add a custom field to a project

POST
/projects/{project_gid}/addCustomFieldSetting
Projects
Custom fields are associated with projects by way of custom field settings. This method creates a setting for the project.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.asana.com/api/1.0/projects//addCustomFieldSetting' \
--header 'Content-Type: application/json' \
--data-raw ''
Response Response Example
200 - Example 1
{
  "data": {
    "gid": "12345",
    "resource_type": "task",
    "custom_field": {
      "gid": "12345",
      "resource_type": "task",
      "display_value": "blue",
      "enabled": true,
      "enum_options": [
        {
          "gid": "12345",
          "resource_type": "task",
          "color": "blue",
          "enabled": true,
          "name": "Low"
        }
      ],
      "name": "Status",
      "number_value": 5.2,
      "resource_subtype": "text",
      "text_value": "Some Value",
      "type": "text",
      "currency_code": "EUR",
      "custom_label": "gold pieces",
      "custom_label_position": "suffix",
      "description": "Development team priority",
      "format": "custom",
      "has_notifications_enabled": true,
      "is_global_to_workspace": true,
      "precision": 2,
      "created_by": {
        "gid": "12345",
        "resource_type": "task",
        "name": "Greg Sanchez"
      },
      "enum_value": {
        "gid": "12345",
        "resource_type": "task",
        "color": "blue",
        "enabled": true,
        "name": "Low"
      },
      "multi_enum_values": [
        {
          "gid": "12345",
          "resource_type": "task",
          "color": "blue",
          "enabled": true,
          "name": "Low"
        }
      ]
    },
    "is_important": false,
    "parent": {
      "gid": "12345",
      "resource_type": "task",
      "name": "Stuff to buy"
    },
    "project": {
      "gid": "12345",
      "resource_type": "task",
      "name": "Stuff to buy"
    }
  }
}

Request

Path Params
project_gid
string 
required
Body Params application/json
data
object (AddCustomFieldSettingRequest) 
optional
custom_field
string 
required
The custom field to associate with this container.
Example:
14916
insert_after
string 
optional
A gid of a Custom Field Setting on this container, after which the new Custom Field Setting will be added. insert_before and insert_after parameters cannot both be specified.
Example:
1331
insert_before
string 
optional
A gid of a Custom Field Setting on this container, before which the new Custom Field Setting will be added. insert_before and insert_after parameters cannot both be specified.
Example:
1331
is_important
boolean 
optional
Whether this field should be considered important to this container (for instance, to display in the list view of items in the container).
Example:
true
Examples

Responses

🟢200Successfully added the custom field to the project.
application/json
Body
data
object (CustomFieldSettingResponse) 
optional
Custom Fields Settings objects represent the many-to-many join of the Custom Field and Project as well as stores information that is relevant to that particular pairing.
custom_field
object 
read-onlyoptional
The custom field that is applied to the parent.
is_important
boolean 
read-onlyoptional
is_important is used in the Asana web application to determine if this custom field is displayed in the list/grid view of a project or portfolio.
Example:
false
parent
object 
read-onlyoptional
The parent to which the custom field is applied. This can be a project or portfolio and indicates that the tasks or projects that the parent contains may be given custom field values for this custom field.
project
object 
read-onlyoptional
Deprecated: new integrations should prefer the parent field. The id of the project that this custom field settings refers to.
gid
string 
read-onlyoptional
Globally unique identifier of the resource, as a string.
Example:
12345
resource_type
string 
read-onlyoptional
The base type of this resource.
Example:
task
🟠400400
🟠401401
🟠403403
🟠404404
🔴500500
Modified at 2022-09-13 02:00:31
Previous
Update a project
Next
Add followers to a project
Built with