Skip to main content

updateCustomer Mutation

Updates the specified Customer object.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_manage_customers, org_crud_customers]. 2. The signed-in User has any of the following permissions for the object: [customer_edit].

Input fields (UpdateCustomerInput!)

nameStringThe name of the Customer, which must be unique within the scope of its Organization.
descriptionStringAdditional notes about the Customer.
allowEmbeddedDesignerBooleanSpecifies whether this Customer can use the Embedded Designer.
labels[String]The labels that are associated with the object.
avatarUrlStringThe URL for the avatar image.
externalIdStringAllows for mapping an external entity to a Prismatic record.
starredBooleanIndicates whether the record is starred by the signed-in User.
addAttachmentAttachmentInputAdds the specified Attachment to the object.
renameAttachmentAttachmentRenameInputRemoves the specified Attachment from the object.
removeAttachmentAttachmentInputRenames the specified Attachment on the object.
idIDThe ID of the Customer to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.

Return fields (UpdateCustomerPayload)

clientMutationId (String)
customer (Customer)
errors ([ErrorType!]!)