Edit a contact

patch

https://api.splio.com/data/contacts/{individual_id}

Edit a contact.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Error cases

Contact does not exist (404)

{
    "status": 404,
    "errors": [
        {
            "error_key": "id",
            "error": "wrong_value",
            "error_description": "Record not found for id {ee}."
        }
    ]
}

Update non-editable parameter (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "unique_key",
            "error": "wrong_value",
            "error_description": "unique key \"email\" can't be updated"
        }
    ]
}

Contact validation KO (400)

See failure cases for Create a contact ⇒ they will result in a 400 here

Path Params

individual_id

string

required

.+

contact unique key.

Body Params

Individual data.

Following the configuration set on the universe, the email OR cellphone OR unique_key can't be modified

lastname

string

firstname

string

creation_date

string

^\d\d\d\d-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01]) (00|[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])$

This date of creation of this contact, will be used for trigger campaigns, Ex: Welcome email. Warning the timezone set for this date is the user api timezone and not the system timezone.

language

string

en, fr, it, es, ...

string

cellphone

string

lists

array of objects

All current memberships of the contact will be removed and replaced by the ones given there. If you want to add or remove only specific list, please use end points /subscribe or /unsubscribe

lists

double_optin

object

[Optional] Require subscribers to confirm their subscription by sending a confirmation request.

Legacy Version

- message: id of the message that must be sent. This message must contain a link to $confirmUrl$

- reminder: id of the reminder message. This message must contain $confirmUrl$ as well.

- reminder_delay: if you want a reminder to be sent, specify the number of days between the first message and the reminder.

{ "message": "aw94xefgh", "reminder": "94was76ef", "reminder_delay": 34 }

Splio Edition 2025

- enabled: Enable double optin

{ "enabled": true }

custom_fields

array of objects

custom_fields

tracking_consent

array of objects

[Optional] Track consent events for this contact. Each entry records a consent state change. The date is interpreted in the universe timezone.

tracking_consent

Responses

401

Authentication failed.

403

Forbidden.

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Error cases

Contact does not exist (404)

Update non-editable parameter (400)

Contact validation KO (400)

200contact edition is successful.

400The request validation failed.