Hello @largeseashells,

Here is an example of the fields in JSON

Hope this helps :)

Take care,

Zach

I tried it that way before but get this error:

{"message":"We're sorry, but something went wrong."}

The change is created despite the error message but the planning_fields are not updated.

Below is an example of my POST request body:

{
    "impact":  1,
    "description":  "api test description",
    "priority":  1,
    "subject":  "api test2 subject",
    "planning_fields":  {                            
                            "reason_for_change":  {
                                                      "description_html":  "<div>adsfdasf</div>",
                                                      "description_text":  "adsfdasf"
                                                  },
                            "change_impact":  {
                                                  "description_html":  "<div>adsfdasf</div>",
                                                  "description_text":  "adsffsafs"
                                              },
                            "rollout_plan":  {
                                                 "description_html":  "<div>adsfdasf</div>",
                                                 "description_text":  "adsfdasf"
                                             },
                            "backout_plan":  {
                                                 "description_html":  "<div>adsfdasf</div>",
                                                 "description_text":  "adsfdasf"
                                             },
                "custom_fields": ""
                        },
    "agent_id":  17001345921,
    "change_type":  1,
    "planned_end_date":  "2021-08-09T22:00:00Z",
    "department_id":  17000159772,
    "requester_id":  17001357715,
    "category":  "Software",
    "group_id":  17000291204,
    "status":  1,
    "email":  "myemail@company.com",
    "planned_start_date":  "2021-08-09T21:00:00Z",
    "risk":  1
}

I tried also skipping characters and differente formatting on the html inside description_html but haven’t gotten it to work.

Thanks,

Orlando

Hello Orlando,

Hmmm that is strange. What I suggest is taking this issue over to the developer community, where we have the DevRel team who can contact those in charge of the API. You can find the community at 

https://community.developers.freshworks.com/ 

If there is an issue with the API they will be able to track it and get it fixed for you.

Take care,

Zach

@largeseashells I completely agree with you that there is an issue with hitting this API endpoint. I tried the same POST request and got the same error message but the Change was still created. This is a big issue and you should take it to the developer community as well as support@freshservice.com

Thank you for bringing this into the light. Hopefully it is fixed quickly.

-Zach

Thanks,

Topic created in developer community for reference:

https://community.developers.freshworks.com/t/need-a-change-planning-field-post-request-example/3342

Regards,

Orlando

Hello, I wanted to update this and include the solution. It should still be addressed in the API documentation in my opinion but to pass planning fields when creating a change request you must include them with the following properties

{"planning_fields": {
            "reason_for_change": {
                "description": "Enter your text here"
            },
            "change_impact": {
                "description": "Enter your text here"
            },
            "rollout_plan": {
                "description": "Enter your text here"
            },
            "backout_plan": {
                "description": "Enter your text here
            }
        }
}

Hello Orlando,

When working with the Freshworks API v2 to create a change request with planning_fields values, you need to include the planning_fields object in the JSON body of your request. The planning_fields object should contain the relevant fields and their corresponding values.

Here's an example of a JSON body to pass in the request for creating a change request with planning_fields values:

{
  "requester_id": "<requester_id>",
  "subject": "Change Request Subject",
  "description": "Change Request Description",
  "status": 1,
  "change_type": 2,
  "planning_fields": {
    "field1": "value1",
    "field2": "value2",
    "field3": "value3"
  }
}

In the above example, you would replace <requester_id> with the actual ID of the requester. The planning_fields object contains three fields (field1, field2, and field3), each with their respective values.

Make sure to replace the other placeholders such as the subject, description, status, and change_type with the appropriate values based on your requirements available on https://zakbags.com/.

Please note that the specific field names and their values within the planning_fields object may vary depending on your Freshworks setup and customization. Refer to the Freshworks API documentation or consult with the Freshworks support team to determine the correct field names and values for your integration.

I hope this example helps you in passing the planning_fields values successfully. If you have any further questions or need additional assistance, feel free to ask.

Best regards