BObonifiq
Customer

Set the birthday date of the given customer

Changed on

Birthday format

Although we use only the day and month part of the Birthday for compatibility reasons the API expects a DateTime as the Birthday date.

This field is expected to have the ISO 8601 format such as 2023-02-03T14:11:10Z.

Note the trailing Z in the previous example: it means the date is in UTC format. This is important to make sure the date is correct.

Birthday cannot be changed

Once set, the birthday date cannot be changed. If you try so the API returns an 400 error with 60 as ErrorCode property

post/v1/pvt/Customer/{id}/setbirthday

Request

  • Base URL
    https://api.bonifiq.com.br
  • Auth
    HTTP basic

Path parameters

idstring required

Request body

Birthdaystring date-time

Response

ErrorMessagestring nullable

Error message returned when the request fails validation or processing. For warnings and successful responses, consumers should usually inspect Result, Code and Severity first.

ErrorCodeinteger nullable

Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use ApiResponseErrorDescription.

Codestring nullable

Endpoint-specific business code formatted as a two-digit string, such as 03 or 07. This field is available for success, warning and error outcomes.

CodeNamestring nullable

Symbolic enum name associated with Code, such as CheckoutNotFound.

Severity0 | 1 | 2

0 = Success 1 = Warning 2 = Error

HasWarningboolean

Convenience flag that is true when Severity is Warning. Warnings are valid 200 OK business outcomes and should not be handled as transport or validation errors.

HasErrorboolean

Indicates whether the request failed and should be handled as an error response. This flag is reserved for real API errors; warnings must keep this property as false.

Changes

  • ab5bc0ffd114Revision changes
    • info

      added the optional property ///// to the response with the status