Update contact list

If you have questions regarding this API, please visit our API FAQ page.

Updating a contact list

Make a PATCH request to https://webapi.inboxroad.com/api/v2/contacts-lists/{blueprint_id}/ with a valid X-API-Key.

curl -X PATCH 'https://webapi.inboxroad.com/api/v2/contacts-lists/{blueprint_id}/' \
  -H 'X-API-Key: <your_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "label": "Updated Newsletter Subscribers",
    "description": "Updated main newsletter contact list"
  }'

Path parameters

Param name	Description
blueprint_id	Unique identifier of the contacts list (UUID).

Request fields

Only the fields supplied in the body are changed.

Field name	Required	Description
label	No	New name for the list.
description	No	New description.
color	No	New hex color from the allowed palette.
fields_order	No	New display order for the list’s fields. Must contain every existing field id exactly once.
unsub_success_redirect_url	No	Redirect URL after a successful unsubscribe.
unsub_failed_redirect_url	No	Redirect URL after a failed unsubscribe.
welcome_on_embed_form_subscribe	No	Send a welcome email when a contact subscribes via an embed form.
welcome_on_single_contact_add	No	Send a welcome email when a contact is added individually.
welcome_email_subject	No	Subject of the welcome email.
welcome_email_template_id	No	Id (UUID) of an email template to use for the welcome email.
welcome_sender_profile_id	No	Id (UUID) of a sender profile to send the welcome email from.
double_opt_in	No	Double opt-in configuration object. Same fields as on create; on update only enabled is required, the rest are optional and patch the existing configuration.

Note

The field schema of a list (which columns exist, and their types) cannot be changed through this endpoint — only the display order via fields_order. color must be one of the allowed palette values.

Example request

{
  "label": "Updated Newsletter Subscribers",
  "description": "Updated main newsletter contact list",
  "color": "#b6d8d5"
}

Response

Returns 200 with the full updated contact list, in the same shape as Get contact list — including the sorted_fields field schema — with one difference: the welcome-email and double opt-in references come back as ids rather than embedded objects.

Field on this response	Equivalent on Get contact list
welcome_email_template_id	welcome_email_template (full object)
welcome_sender_profile_id	welcome_sender_profile (full object)
double_opt_in.email_template_id	double_opt_in.email_template (full object)
double_opt_in.sender_profile_id	double_opt_in.sender_profile (full object)

Call Get contact list after updating if you need the expanded template and sender profile objects.

Possible response codes

Status code	Description
200	Contact list updated successfully.
400	The color is not in the allowed palette, or the welcome-email / double opt-in settings are inconsistent.
401	Unauthorized.
404	Contact list not found.
422	blueprint_id is not a valid UUID, or the body failed validation.
429	Rate limit exceeded. See Rate limiting.