Update an email contact point for the user profile
patch
/fscmRestApi/resources/11.13.18.05/publicSectorProfileContactEmails/{ContactPtId}
Request
Path Parameters
-
ContactPtId(required): integer(int64)
The unique identifier for the email contact point.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ContactPointPurpose: string
Title:
Type
The email type. Valid values are BUSINESS for work and PERSONAL for home. -
EmailAddress: string
Title:
Email
The email address for the email contact point. -
PrimaryFlag: string
Title:
Primary
Maximum Length:1
Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no. -
Status: string
The status of the email contact point. Valid values are A for active and I for inactive.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorProfileContactEmails-item-response
Type:
Show Source
object
-
ContactPointPurpose: string
Title:
Type
The email type. Valid values are BUSINESS for work and PERSONAL for home. -
ContactPtId: integer
(int64)
The unique identifier for the email contact point.
-
EmailAddress: string
Title:
Email
The email address for the email contact point. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryFlag: string
Title:
Primary
Maximum Length:1
Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no. -
ProfileId: integer
(int64)
The unique identifier for the profile that is associated with the email contact point.
-
Status: string
The status of the email contact point. Valid values are A for active and I for inactive.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.