Update the wallet
PATCH
https://api-v2.test.eldowallet.fr/wallets
Updates the wallet of the token used: name, contact details, social networks, logos, time zone, webhooks or terms and conditions. Only the fields you send are changed; accepts multipart/form-data (for images) or application/json.
Good to know
- Body is
multipart/form-data: nested objects (colors,security,locations…) are sent as a JSON string, booleans as"true"/"false". Images: PNG or JPEG, 1 KB to 5 MB. termsAndConditions.customUrlis required whentypeisURL.- Any real change updates the installed passes in the background: loyalty cards every time, the other pass types when a field they display changes (name, logos, phones…). Loyalty card holders are notified according to the
UPDATE_LOYALTYrule, which uses credits; credit is checked before anything is saved (INSUFFICIENT_CREDIT, or409 INSUFFICIENT_CREDIT_PARTIAL, which you can override withacceptPartialDelivery: true). A request that changes nothing triggers nothing.
Request
header parameters
x-langstringLanguage for responsesenum:en,frdefault:"en"
Body
multipart/form-data requiredwebHookUrlstringComma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20tokeniconstring <binary>logostring <binary>androidLogostring <binary>namestringidentifierstringidentifierQrstringaddressstringwebsitestringservicePhonestringbusinessPhonestringsocialMediaobjectlinkedinstringtiktokstringtwitterstringfacebookstringinstagramstringyoutubestringsnapchatstringpintereststringredditstringwhatsappstringtelegramstring
additionalContactsobject[]titlestring requiredvaluestring requiredkindstring requiredenum:URL,PHONE,EMAIL
termsAndConditionsobjecttypestringType of terms and conditionsenum:PDF,URL,NONEexample:PDFcustomUrlstring <uri>Custom URL for terms and conditions (maps to generalRoleUrl)example:https://example.com/termspdfFilestring <binary>
rootDomainstringtimezonestringallowedPassesstring[]enum:ALL,EVENT_TICKET,TRANSIT,CINEMA,BOARDING_PASS,COUPON,GENERIC,STORE_CARD,OFFER,HOTELexpiredCleanupEnabledboolean
Body
application/json requiredwebHookUrlstringComma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20tokeniconstring <binary>logostring <binary>androidLogostring <binary>namestringidentifierstringidentifierQrstringaddressstringwebsitestringservicePhonestringbusinessPhonestringsocialMediaobjectlinkedinstringtiktokstringtwitterstringfacebookstringinstagramstringyoutubestringsnapchatstringpintereststringredditstringwhatsappstringtelegramstring
additionalContactsobject[]titlestring requiredvaluestring requiredkindstring requiredenum:URL,PHONE,EMAIL
termsAndConditionsobjecttypestringType of terms and conditionsenum:PDF,URL,NONEexample:PDFcustomUrlstring <uri>Custom URL for terms and conditions (maps to generalRoleUrl)example:https://example.com/termspdfFilestring <binary>
rootDomainstringtimezonestringallowedPassesstring[]enum:ALL,EVENT_TICKET,TRANSIT,CINEMA,BOARDING_PASS,COUPON,GENERIC,STORE_CARD,OFFER,HOTELexpiredCleanupEnabledboolean
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 415
- 500
- 503
Schema
application/jsonnamestring requiredlogostring requirediconstring requiredandroidLogostringdisplayIdentifiantboolean requiredpassBuilderPassTemplateIdstringpassBuilderBusinessIdstringpassBuilderTokenstringidentifierstring requiredidentifierQrstring requiredaddressstringwebsitestring requiredservicePhonestring requiredbusinessPhonestring requiredsocialMediaobject requiredlinkedinstringfacebookstringinstagramstringtiktokstringtwitterstringyoutubestringsnapchatstringpintereststringredditstringwhatsappstringtelegramstring
additionalContactsobject[] requiredtitlestring requiredvaluestring requiredkindstring requiredenum:URL,PHONE,EMAIL
termsAndConditionsobject requiredtypestring requiredenum:PDF,URL,NONEcustomUrlstringpdfUrlstring
webHookUrlstring requiredrootDomainstring requiredtimezonestringallowedPassesstring[] requiredenum:ALL,EVENT_TICKET,TRANSIT,CINEMA,BOARDING_PASS,COUPON,GENERIC,STORE_CARD,OFFER,HOTELexpiredCleanupEnabledboolean required_idstring requiredcreatedAtstring <date-time> requiredupdatedAtstring <date-time> required
VALIDATION_ERROR · INVALID_JSON · INVALID_MULTIPART · INSUFFICIENT_CREDIT
Schema
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
UNAUTHORIZED
Schema
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
FORBIDDEN
Schema
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
MODEL_NOT_FOUND · WALLET_UPDATE_FAILED
Schema
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
INSUFFICIENT_CREDIT_PARTIAL · PASSBUILDER_IDENTITY_PROVISIONING · PASSBUILDER_IDENTITY_INCOMPLETE
Schema
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
UNSUPPORTED_MEDIA_TYPE
Schema
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
UNKNOWN_ERROR
Schema
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
PASS_BUILDER_ERROR
Schema
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email