Create a contact

Create a contact.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Error cases

Already existing unique_key (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "id",
            "error": "wrong_value",
            "error_description": "contact with unique key test_existing already exists"
        }
    ]
}

Missing unique_key (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "contact_key",
            "error": "wrong_contact_key",
            "error_description": "Bad key formating against universe key, c0 is empty"
        }
    ]
}

Malformatted value - ex: price as String (400)

Generic error for all fields and custom fields values types

{
    "status": 400,
    "errors": [
        {
            "error_key": "custom_fields",
            "error": "wrong_type",
            "error_description": "Custom field with id 5 and name Date_de_test must be of type date."
        }
    ]
}

Non-existing list (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "list_id",
            "error": "wrong_value",
            "error_description": "list 777 does not exist"
        }
    ]
}

Non-existing custom_field (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "custom_fields",
            "error": "wrong_value",
            "error_description": "Custom field not found for id 145."
        }
    ]
}

Malformatted email (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "email",
            "error": "wrong_email",
            "error_description": "The email given should have the right format"
        }
    ]
}

Malformatted list (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "list_id",
            "error": "wrong_value",
            "error_description": "lists for contact created should contains id key"
        }
    ]
}

Double optin without list (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "double_optin",
            "error": "wrong_value",
            "error_description": "double optin option should have some lists to prepare"
        }
    ]
}
Body Params

Individual data.

Following the configuration set on the universe, the mandatory field should email OR cellphone OR unique_key

string
string
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.

string

en, fr, it, es, ...

string
string
lists
array of objects
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 settings

custom_fields
tracking_consent
array of objects
Responses

401

Authentication failed.

403

Forbidden.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json