V3 REFERENCE Contact Lists

/contactslistsignup

Contacts list signup request.

List contactslistsignup resources available for this apikey, use a GET request. Alternatively, you may want to add one or more filters.

# list contactslistsignup resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/contactslistsignup
Properties
Name Description
ConfirmAt Timestamp when signup confirmation was registered.
  • [ Type Int64 ]
ConfirmIp IP address detected during signup confirmation.
  • [ Type AnsiString ]
ContactID
OR
ContactALT
ContactID
ID reference to Contact
ContactALT
Value of the Email field of the related Contact resource
  • [ Type TContact ]
Email Email address to be signed up.
  • Mandatory
  • [ Type TEmail ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
ListID
OR
ListALT
ListID
ID reference to ContactsList
ListALT
Value of the Address field of the related ContactsList resource
  • Mandatory
  • [ Type TContactsList ]
SignupAt Timestamp of sign up registration.
  • [ Type Int64 ]
SignupIp IP address detected during signup registration.
  • [ Type AnsiString ]
SignupKey Unique confirmation key needed for confirmation.
  • [ Type AnsiString ]
Source Where did the signup request come from.
  • Mandatory
  • [ Type AnsiString ]
SourceId ID of signup request entity (usually widget ID).
  • [ Type Int64 ]
Filters
Name Description
APIKey Only retrieve signup requests for given API key.
  • [ Type Int64 ]
Contact Only retrieve ContactsListSignup resources for which Contact ID equals the specified value.
  • [ Type Int64 ]
ContactsList Only retrieve signup requests for given contacts list.
  • [ Type Int64 ]
Domain Only retrieve signup requests for given email domain.
  • [ Type AnsiString ]
Email Shortcut fot filtering on Localpart@domain.
  • [ Type AnsiString ]
LocalPart Only retrieve signup requests for given email local part. If specified, domain must also be specified.
  • [ Type AnsiString ]
MaxConfirmAt Only retrieve signup requests for which ConfirmAt is less than specified value.
  • [ Type Int64 ]
MaxSignupAt Only retrieve signup requests for which SignupAt is less than specified value.
  • [ Type Int64 ]
MinConfirmAt Only retrieve signup requests for which ConfirmAt is larger than specified value.
  • [ Type Int64 ]
MinSignupAt Only retrieve signup requests for which SignupAt is larger than specified value.
  • [ Type Int64 ]
SignupIp (AnsiString: Only retrieve contactslistsignup resources for which SignupIp equals the specified value.)
  • [ Type AnsiString ]
Source Only retrieve ContactsListSignup resources for which Source equals the specified value.
  • [ Type AnsiString ]
SourceID Only retrieve ContactsListSignup resources for which SourceID equals the specified value.
  • [ Type Int64 ]

Access a given contactslistsignup resource, use a GET request, providing the contactslistsignup's ID value.

# access the contactslistsignup resource identified by $ID

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/contactslistsignup/$ID

    
    
Properties
Name Description
ConfirmAt Timestamp when signup confirmation was registered.
  • [ Type Int64 ]
ConfirmIp IP address detected during signup confirmation.
  • [ Type AnsiString ]
ContactID
OR
ContactALT
ContactID
ID reference to Contact
ContactALT
Value of the Email field of the related Contact resource
  • [ Type TContact ]
Email Email address to be signed up.
  • Mandatory
  • [ Type TEmail ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
ListID
OR
ListALT
ListID
ID reference to ContactsList
ListALT
Value of the Address field of the related ContactsList resource
  • Mandatory
  • [ Type TContactsList ]
SignupAt Timestamp of sign up registration.
  • [ Type Int64 ]
SignupIp IP address detected during signup registration.
  • [ Type AnsiString ]
SignupKey Unique confirmation key needed for confirmation.
  • [ Type AnsiString ]
Source Where did the signup request come from.
  • Mandatory
  • [ Type AnsiString ]
SourceId ID of signup request entity (usually widget ID).
  • [ Type Int64 ]