Update partial Consumer Point User data
  • 17 Jan 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Update partial Consumer Point User data

  • Dark
    Light
  • PDF

Article summary

Patch
/consumer-points-user/{id}/

Operation updates given Consumer Point User fields.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of Consumer Point User to update

Body parameters

Consumer Point User attributes and values to be updated

object

Consumer Point User object. Flat version for patch and post methods

Address
integer

Address ID

activity
integer

SnConstant with group name CP_ACTIVITY

by_email
boolean

Specifies if consumerpoint user notify via email

by_landline
boolean

Specifies if consumerpoint user notify via landline

by_sms
boolean

Specifies if consumerpoint user notify via sms

category
integer

SnConstant with group name CP_CATEGORY

consumer_point
integer

Consumer Point ID

created_ts
string (date-time)

Date created

id
integer

Primary key

is_activated
boolean

Specifies if consumerpint user is activated or not

landline
string

Consumerpoint user landline number

name
string

Consumer Point User name

no_sms
boolean

Specifies if consumerpoint user sms sending was disabled or not

phone
string

Consumer Point User phone number

restricted_type
integer

TxtConstant with group name KU_RESTRICTED_TYPE

source
integer

SnConstant with group name CP_SOURCE

updated_ts
string (date-time)

Date updated

username
string

Consumer Point User username

Responses
200

Object was updated successfully

object

Consumer Point User object. Flat version for patch and post methods

Address
integer

Address ID

activity
integer

SnConstant with group name CP_ACTIVITY

by_email
boolean

Specifies if consumerpoint user notify via email

by_landline
boolean

Specifies if consumerpoint user notify via landline

by_sms
boolean

Specifies if consumerpoint user notify via sms

category
integer

SnConstant with group name CP_CATEGORY

consumer_point
integer

Consumer Point ID

created_ts
string (date-time)

Date created

id
integer

Primary key

is_activated
boolean

Specifies if consumerpint user is activated or not

landline
string

Consumerpoint user landline number

name
string

Consumer Point User name

no_sms
boolean

Specifies if consumerpoint user sms sending was disabled or not

phone
string

Consumer Point User phone number

restricted_type
integer

TxtConstant with group name KU_RESTRICTED_TYPE

source
integer

SnConstant with group name CP_SOURCE

updated_ts
string (date-time)

Date updated

username
string

Consumer Point User username

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object
details
string

Detailed description of error


Was this article helpful?