Update Account Terms Acceptances

put

https://example.com/programs/{programCode}/accounts/{accountIdentifier}

This endpoint can be used to assign account identifiers to customer accounts or to opt in or out of any terms or agreements that were agreed to or declined during enrollment

Path Params

programCode

string

required

Partner program code for the account.

accountIdentifier

string

required

Unique account identifier (UID or GUID).

Body Params

Encrypted request to update terms acceptances. See Gd.Bos.DataTransfer.Request.UpdateTermsAcceptancesEncryptedRequest for required fields.

encryptedEmail

object

Represents a container for encrypted data used in secure data transfer operations. Contains the encrypted payload and associated cryptographic metadata, including encryption version, ephemeral public key, and public key hash. Used to securely transmit sensitive information such as user data, ensuring confidentiality and integrity during transport.

termsAcceptances

array of objects | null

The list of terms acceptances to be updated for the account. Each item represents a specific terms and conditions acceptance record.

termsAcceptances

partnerAccountIdentifier

string | null

Optional. The partner's account identifier, if applicable. Used for cross-referencing with partner systems.

Headers

X-GD-RequestId

string

required

Unique request tracking identifier (X-GD-RequestId header).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

text/json

200OK

403Forbidden

500Internal Server Error

503Service Unavailable