Jump to

• Request
• Response

Update a service profile contact

patch

/crmRestApi/resources/11.13.18.05/serviceProfiles/{serviceProfiles_Id}/child/contacts/{serviceProfiles_contacts_Id}

Request

Path Parameters

• serviceProfiles_Id(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• serviceProfiles_contacts_Id(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• PrimaryContactFlag: boolean
  Title: Primary

  Indicates the contact is the primary contact for the service profile.

{
    "type":"object",
    "properties":{
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates the contact is the primary contact for the service profile.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : serviceProfiles-contacts-item-response

Type: object

Show Source

• ContactEmailAddress: string
  Title: Contact Email Address

  Read Only: true

  Maximum Length: 320

  The email address of the contact belonging to the service profile.
• ContactFormattedPhoneNumber: string
  Title: Phone Number

  Read Only: true

  The phone number of the contact belonging to the service profile.
• ContactPartyName: string
  Title: Contact Name

  Read Only: true

  Maximum Length: 360

  The name of the contact belonging to the service profile.
• ContactPartyNumber: string
  Title: Contact Number

  Read Only: true

  Maximum Length: 30

  The PUID of the contact belonging to the service profile.
• ContactPartyUniqueName: string
  Title: Contact Unique Name

  Read Only: true

  Maximum Length: 900

  The unique name of the contact belonging to the service profile.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user that created the service profile contact.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the service profile contact was created.
• JobTitle: string
  Title: Job Title

  Read Only: true

  Maximum Length: 100

  The job title of the contact belonging to the service profile.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the service profile contact was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the service profile contact.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the service profile contact.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Title: Party ID

  The contact for the service profile contact.
• PrimaryContactFlag: boolean
  Title: Primary

  Indicates the contact is the primary contact for the service profile.
• ServiceProfileId: integer (int64)
  Title: Service Profile ID

  The service profile for the service profile contact.
• ServiceProfileName: string
  Title: Service Profile Name

  Read Only: true

  Maximum Length: 400

  The name of the service profile for the service profile contact.
• ServiceProfileNumber: string
  Title: Service Profile Number

  Maximum Length: 30

  The PUID of the service profile for the service profile contact.
• SpContactId: integer (int64)
  Title: Service Profile Contact ID

  Read Only: true

  The unique identifier of the service profile contact.

{
    "type":"object",
    "properties":{
        "ContactEmailAddress":{
            "title":"Contact Email Address",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the contact belonging to the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ContactFormattedPhoneNumber":{
            "title":"Phone Number",
            "type":"string",
            "description":"The phone number of the contact belonging to the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContactPersonalPhoneFlag",
                    "ContactPrimaryPhoneAreaCode",
                    "ContactPrimaryPhoneContactPtId",
                    "ContactPrimaryPhoneCountryCode",
                    "ContactPrimaryPhoneExtension",
                    "ContactPrimaryPhoneLineType",
                    "ContactPrimaryPhoneNumber"
                ]
            }
        },
        "ContactPartyName":{
            "title":"Contact Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the contact belonging to the service profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The PUID of the contact belonging to the service profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyUniqueName":{
            "title":"Contact Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique name of the contact belonging to the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user that created the service profile contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the service profile contact was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the contact belonging to the service profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the service profile contact was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the service profile contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the service profile contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The contact for the service profile contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates the contact is the primary contact for the service profile.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "ServiceProfileId":{
            "title":"Service Profile ID",
            "type":"integer",
            "description":"The service profile for the service profile contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ServiceProfileName":{
            "title":"Service Profile Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the service profile for the service profile contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceProfileNumber":{
            "title":"Service Profile Number",
            "maxLength":30,
            "type":"string",
            "description":"The PUID of the service profile for the service profile contact.",
            "nullable":false,
            "x-queryable":true
        },
        "SpContactId":{
            "title":"Service Profile Contact ID",
            "type":"integer",
            "description":"The unique identifier of the service profile contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top