custom_field_id: Property was found but is not permitted at this location

[SpencerF23]

This is the post request with custom fields

{"email_addresses":[{"opt_in_source":"ACTION_BY_OWNER","email_address":"test@example.com"}],"first_name":"Mitch","last_name":"Elis","job_title":null,"company_name":null,"custom_fields": [{"custom_field_id": "2afaadda-917c-11ed-bdf2-fa1XXXXX","value": "TEST VALUE"}],"lists":[{"id":"1038927000"}]}

I keep getting this error

[{

"error_key": "json.field.invalid",

"error_message": "#/custom_fields/0/custom_field_id: Property was found but is not permitted at this location."

}, {

"error_key": "json.field.missing",

"error_message": "#/custom_fields/0/name: Property is required but not found."

}]

Please help resolving this issue.

[MarkT701]

I believe this is the standard error message when the recipients email address has been blocked from receiving by the recipient. In other words, they have opted out of receiving emails from CC

[SpencerF23]

Hi Mark, thanks for replying. I just shared screenshots from the CC API test tool. It seems to be something with the custom field because it works without it, but not with it. And we really do want to be able to send the custom field info.

[SpencerF23]

[redacted for security/privacy]

[Courtney_E · Accepted solution]

Hello SpencerF23,

Thank you for reaching out to Constant Contact API Developer Support. My team is here to assist outside software developers with questions about building into Constant Contact's API.

It looks like you are using our legacy V2 API, which has some limitations regarding Custom Fields as far as the amount that can be utilized and the naming convention allowed.

Our legacy V2 API supports very specific Custom Field names that must be in the format of "Custom Field n", where n = 1 - 15 if imported through bulk methods, or CustomFieldn format if using our individual contact API endpoints. 

Custom Fields are only accessible via the legacy V2 API if they meet the required naming conventions.

API and GUI Differences & Unsupported GUI functionality

https://v2.developer.constantcontact.com/docs/contacts-api/api-gui-func.html

V2 API Custom Field Limitations

https://v2.developer.constantcontact.com/docs/contacts-api/api-gui-func.html

As a side note, while no date is currently set, there will be a point in the near future where our legacy V2 API will begin deprecation, as the deprecation process for our retired V1 API is nearly complete. Due to this, while we will continue to deploy critical bug fixes at this time, we will not be doing any more development for V2 or its endpoints, and strongly recommend upgrading to the V3 API to ensure you're ahead of the curve.

Our V3 API Custom Fields allow up to 100 and uses "custom_field_id" rather than the limited naming convention offered by V2:

https://v3.developer.constantcontact.com/api_guide/custom_fields.html

Please have a look and let us know if you have any other questions!

[SpencerF23]

Thank you!