• chore: remove manual Index section from Profile System API overviewlatestno API changesDocs7f6e4132026-05-14 19:09
• update: replace app keys with api keysno API changesDocs0e1c84a2025-08-28 14:01
• update: replace application key with api keyno API changesDocs83f76a72025-08-12 22:38
• apply suggestionno API changesDocsdf27bb52024-11-22 19:57
• update profileId and alternativeKey fields1632Docsd3de6ba2024-11-22 19:45

  Change detail

  48 changes across 16 operations

  AllBreakingWarningInfo

  • DELETE/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
    • breaking

      the query request parameter alternativeKey was restricted to a list of enum values

    • info

      added the new enum value document to the query request parameter alternativeKey

    • info

      added the new enum value email to the query request parameter alternativeKey

  • GET/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
    • breaking

      the query request parameter alternativeKey was restricted to a list of enum values

    • info

      added the new enum value document to the query request parameter alternativeKey

    • info

      added the new enum value email to the query request parameter alternativeKey

  • PATCH/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
    • breaking

      the query request parameter alternativeKey was restricted to a list of enum values

  View all changes (48)
• fix spectral rulesno API changesDocsaeeff9a2024-06-13 18:55
• edit examplesno API changesDocs577cca12024-06-13 18:32
• remove example from response schema - ProspectMetano API changesDocsa653f082024-06-13 18:27
• remove example from schema - used only in responseno API changesDocs656ba622024-06-13 18:25
• profile system - modify title and descriptions to include data protection plusno API changesDocs0c2cd8d2024-04-30 14:48
• fix spectral issues - profile system6Docsc03edb42024-01-22 13:49

  Change detail

  6 changes across 6 operations

  AllBreakingWarningInfo

  • GET/api/storage/profile-system/profiles/{profileId}
    • info

      the response property items/meta/lastUpdate became required for the status 200

  • PATCH/api/storage/profile-system/profiles/{profileId}
    • info

      the response property meta/lastUpdate became required for the status 200

  • GET/api/storage/profile-system/profiles/{profileId}/unmask
    • info

      the response property items/meta/lastUpdate became required for the status 200

  • GET/api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}
    • info

      the response property items/meta/lastUpdate became required for the status 200

  • GET/api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}/unmask
    • info

      the response property items/meta/lastUpdate became required for the status 200

  • POST/api/storage/profile-system/profiles
    • info

      the response property meta/lastUpdate became required for the status 201

• Update VTEX - Profile System.json1Docs1c698432023-12-01 17:50

  Change detail

  1 change across 1 operation

  AllBreakingWarningInfo

  • GET/api/storage/profile-system/prospects/unmask
    • info

      api operation id GetProspects removed and replaced with GetUnmaskedProspects

• add contactId - profile system10Docs1a393dd2023-11-21 18:55

  Change detail

  10 changes across 8 operations

  AllBreakingWarningInfo

  • PATCH/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
    • info

      added the new optional request property contactId

    • info

      added the optional property document/contactId to the response with the 200 status

  • POST/api/storage/profile-system/profiles/{profileId}/addresses
    • info

      added the new optional request property contactId

    • info

      added the optional property document/contactId to the response with the 201 status

  • GET/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
    • info

      added the optional property document/contactId to the response with the 200 status

  • GET/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/unmask
    • info

      added the optional property document/contactId to the response with the 200 status

  • GET/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId}
    • info

      added the optional property document/contactId to the response with the 200 status

  • GET/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId}/unmask
    • info

      added the optional property document/contactId to the response with the 200 status

  • GET/api/storage/profile-system/profiles/{profileId}/addresses
    • info

      added the optional property items/document/contactId to the response with the 200 status

  • GET/api/storage/profile-system/profiles/{profileId}/addresses/unmask
    • info

      added the optional property items/document/contactId to the response with the 200 status

• remove `s`no API changesDocs7e0552a2023-11-06 23:26
• add endpoint urlno API changesDocs67de7d12023-11-06 21:41
• Apply suggestions from code reviewno API changesDocs7bd6d272023-11-06 21:37
• add remaining permissionsno API changesDocs0c26beb2023-11-01 21:43
• Merge branch 'master' into profile-system-api-schema717Docs3fdc3692023-11-01 21:37

  Change detail

  24 changes across 10 operations

  AllBreakingWarningInfo

  • PATCH/api/storage/profile-system/profiles/{profileId}
    • breaking

      removed the required property meta/lastUpdateDate from the response with the 200 status

    • info

      added the new optional request property {customField}

    • info

      added the optional property document/{customField} to the response with the 200 status

    • info

      added the optional property meta/lastUpdate to the response with the 200 status

  • POST/api/storage/profile-system/profiles
    • breaking

      removed the required property meta/lastUpdateDate from the response with the 201 status

    • info

      added the new optional request property {customField}

    • info

      added the optional property document/{customField} to the response with the 201 status

  View all changes (24)
• add missing schemas and examples14Docs65cd7f12023-11-01 17:41
• turn paymentData into schema and add examples1672Docs12e2c4f2023-11-01 17:28
• apply suggestions from code reviewno API changesDocs0dc94282023-11-01 17:08
• add prospect information - Profile System API71444Docs2005c192023-10-31 18:07
• Merge branch 'master' into profile-system-api-schema717Docsf720c982023-10-26 18:10
• add periodno API changesDocs7202a652023-10-26 17:11
• add period81427Docsbdd7faf2023-10-26 17:08
• add custom field8Docs7ee10ea2023-10-24 21:22
• add default schema22Docsd878a8a2023-10-24 21:00
• edit sensitive and pii descriptions112014Docse3332872023-10-24 20:51
• add purchase information schemas and examples417Docsfe2c8af2023-10-24 16:38
• add purchase information schema4610Docs394575e2023-10-24 15:23
• fix examples66Docs278242f2023-10-23 14:48
• update schemasno API changesDocs57e1a272023-10-23 14:36
• Merge branch 'master' into profile-system-api-schema13Docs12a9cd62023-10-23 14:29
• add items to schemano API changesDocs7a065572023-10-20 16:52
• fix schema path8Docsb6977a72023-10-20 16:44
• edit schema + prospectId1Docs61447802023-10-18 18:33
• add address schemas, edit profile schemas, add links826Docs96b52242023-10-18 18:08
• rename profile id schema1Docs599ea1b2023-10-18 17:38
• update servers and security info2Docsd1bdcb02023-10-18 17:34
• edit schemas916Docs7f4c08f2023-10-18 17:31
• format document + add create client profile response schema3Docs78d496b2023-10-18 16:29
• Update VTEX - Profile System.json31Docs096c3c22023-10-11 14:24
• delete previous schema route and add new route43Docs105e6362023-10-09 18:58
• format document, add schema endpoints3Docs51da3ec2023-10-09 18:36
• add permissionsno API changesDocsa40276b2023-10-09 18:16
• edit description + add permissionsno API changesDocs87f3b2a2023-10-09 18:12
• Update VTEX - Profile System.jsonno API changesDocs1ac092e2023-07-18 14:43
• solving conflictno API changesDocs38b42912023-07-17 22:07
• Update VTEX - Profile System.jsonno API changesDocs212a59d2022-11-04 18:09
• Update VTEX - Profile System.jsonDocs4e706f42022-11-04 18:09

Revisions go back to the API's first capture.