Add a custom field to a table

post

https://app.asana.com/api/1.0/tables/{table_gid}/addCustomFieldSetting

Required scope: tables:write

Custom fields are associated with tables by way of custom field settings. This method creates a setting for the table.
Unlike projects and portfolios, tables only support custom fields that are global (published) to the workspace. Reusing a non-global custom field, or creating a new field inline that isn't global, will fail with a 403 Forbidden error.

Path Params

table_gid

string

required

Globally unique identifier for the table.

Query Params

opt_fields

array of strings

This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide.

opt_fields

opt_pretty

boolean

Provides “pretty” output.
Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

Body Params

Information about the custom field setting.

data

object

Responses

200Successfully added the custom field to the table.

400This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.

401A valid authentication token was not provided with the request, so the API could not associate a user with the request.

402The request was valid, but the queried object or object mutation specified in the request is above your current premium level.

403The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to.

404Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.

500There was a problem on Asana’s end. In the event of a server error the response body should contain an error phrase. These phrases can be used by Asana support to quickly look up the incident that caused the server error. Some errors are due to server load, and will not supply an error phrase.