sendgrid / docs

Repository of Twilio SendGrid's product documentation.
https://sendgrid.com/docs
MIT License
235 stars 967 forks source link

marketing/contacts endpoint w/ custom_fields option not sufficiently documented #5793

Closed mjezew closed 3 years ago

mjezew commented 4 years ago

it should be made clear that when using the custom_fields option in the /marketing/contacts v3 api call that the custom field ID should be provided, and not the custom field name. this caught me up for a while. I'm guessing this spec will change, hence its lack of documentation, but indicating how it can be done in the meantime with a note that it will change would be best imo.

Expected content

custom_fields: object (optional) provide the custom field id (which can be retrieved from the GET /marketing/field_definitions endpoint

Actual content

custom_fields: object (optional) Link to page: https://sendgrid.com/docs/API_Reference/api_v3.html

Whatthefoxsays commented 4 years ago

Hi @mjezew,

I'm sorry you struggled with this issue, but we really appreciate the feedback! We've added this to our internal docs backlog and will hopefully get it resolved shortly.

Twilio SendGrid Docs Team