How do I add a custom field to an issue type screen scheme via the API?

[Kyle Wright]

I need to add a custom field to an issue type screen scheme via the API. I'm currently using the v2 API. I'm aware that I can add a field to the default screen, but given a non-default screen, is it possible to add a custom field to it via the API?

Docs:

- https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screens/#api-rest-api-2-screens-addtodefault-fieldid-post

- https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screens/#api-rest-api-2-screens-screenid-put

- https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-type-screen-schemes/#api-rest-api-2-issuetypescreenscheme-issuetypescreenschemeid-mapping-put

[Chu Dam · Accepted solution]

Hi @Kyle Wright 

but given a non-default screen, is it possible to add a custom field to it via the API?

You need to use the Add screen tab field API here: 

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screen-tab-fields/#api-rest-api-2-screens-screenid-tabs-tabid-fields-post

POST /rest/api/2/screens/{screenId}/tabs/{tabId}/fields

With this endpoint you can choose the screen and the tab you need to add field in... ;) 

I hope this helps. 

Cheers,
Dam. 

[Kyle Wright]

You're a lifesaver. Thanks Dam!