POST /goals/{goal_gid}/addCustomFieldSetting
Required scope: goals:write
Custom fields are associated with goals by way of custom field settings. This method creates a setting for the goal.
Servers
- https://app.asana.com/api/1.0
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
goal_gid |
String | Yes |
Globally unique identifier for the goal. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
opt_pretty |
Boolean | No |
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. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
data |
Object | No | |
data.insert_after |
String | No |
A gid of a Custom Field Setting on this container, after which the new Custom Field Setting will be added. |
data.custom_field |
Yes | ||
data.is_important |
Boolean | No |
Whether this field should be considered important to this container (for instance, to display in the list view of items in the container). |
data.insert_before |
String | No |
A gid of a Custom Field Setting on this container, before which the new Custom Field Setting will be added. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.