Skip to main content

Update Contact

You can update an existing contact in your account by sending a PATCH request to the API endpoint. Your request must include the contact's email address and any additional fields you want to update.

Endpoint Information

Endpoint: https://manage.maileroo.app/v1/contact/[:list_id]/[:email_address]
Method: PATCH
Content Type: application/json

Where To Find Your List ID

You can find your list ID in your when you to go to your 'Contacts' section within your organization. There it will display the list-id that you can use in this endpoint.

Request

You can update an existing contact in your account by sending a PATCH request to the API endpoint. Your request must include the contact's email address and any additional fields you want to update.

Request Headers

Content-Type: application/json
X-API-Key: YOUR_API_KEY_HERE

Request Body

{
"subscriber_name": "John Doe",
"subscriber_timezone": "America/New_York",
"subscriber_tags": "tag1,tag2",
"subscriber_status": "UNCONFIRMED",
"custom_field1": "value1",
"custom_field2": "value2"
}

Updateable Fields

FieldTypeDescription
subscriber_namestringFull name of the contact
subscriber_timezonestringTimezone of the contact (e.g., "America/New_York")
subscriber_tagsstringComma-separated list of tags for the contact
subscriber_statusstringStatus of the contact (e.g., "SUBSCRIBED", "UNSUBSCRIBED", "UNCONFIRMED")

You may also include any custom fields that you have defined for your contacts.

Response

The response will be a JSON object containing the following fields:

FieldTypeDescription
successbooleanBoolean indicating whether the request was successful
messagestringMessage describing the result of the request