Jump to

• Request
• Response

Update a company profile

patch

/crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/CompanyProfiles/{Id}

Request

Path Parameters

• 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=
• Name(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

• Addressline: string
  Maximum Length: 100

  The first line of the organization address.
• BusinessUnit: string
  Maximum Length: 80

  Business Unit
• CompanyName: string
  Maximum Length: 80

  Company Name
• CorporateCurrency: string
  Maximum Length: 80

  Default Value: USD

  The default corporate currency code.
• Country: string
  Maximum Length: 80

  Default Value: US

  The country of the enterprise.
• EnterpriseName: string
  Maximum Length: 100

  The name of the enterprise.
• IsDataExisting: string
  Maximum Length: 80

  Indicates if the enterprise setup data was created before running the Setup Assistant.
• LegalEntity: string
  Maximum Length: 80

  Legal Entity
• OfferingName: string
  Maximum Length: 80

  Offering Name
• TaxRegNumber: string
  Maximum Length: 80

  Enterprise Tax Registration Number

{
    "type":"object",
    "properties":{
        "Addressline":{
            "maxLength":100,
            "type":"string",
            "description":"The first line of the organization address.",
            "nullable":true
        },
        "BusinessUnit":{
            "maxLength":80,
            "type":"string",
            "description":"Business Unit",
            "nullable":true
        },
        "CompanyName":{
            "maxLength":80,
            "type":"string",
            "description":"Company Name",
            "nullable":true
        },
        "CorporateCurrency":{
            "maxLength":80,
            "type":"string",
            "description":"The default corporate currency code.",
            "nullable":false,
            "default":"USD",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Country":{
            "maxLength":80,
            "type":"string",
            "description":"The country of the enterprise.",
            "nullable":true,
            "default":"US",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnterpriseName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the enterprise.",
            "nullable":true
        },
        "IsDataExisting":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates if the enterprise setup data was created before running the Setup Assistant.",
            "nullable":true
        },
        "LegalEntity":{
            "maxLength":80,
            "type":"string",
            "description":"Legal Entity",
            "nullable":true
        },
        "OfferingName":{
            "maxLength":80,
            "type":"string",
            "description":"Offering Name",
            "nullable":true
        },
        "TaxRegNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Enterprise Tax Registration Number",
            "nullable":true
        }
    }
}

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 : setupAssistants-CompanyProfiles-item-response

Type: object

Show Source

• Addressline: string
  Maximum Length: 100

  The first line of the organization address.
• BusinessUnit: string
  Maximum Length: 80

  Business Unit
• CompanyName: string
  Maximum Length: 80

  Company Name
• CorporateCurrency: string
  Maximum Length: 80

  Default Value: USD

  The default corporate currency code.
• Country: string
  Maximum Length: 80

  Default Value: US

  The country of the enterprise.
• EnterpriseName: string
  Maximum Length: 100

  The name of the enterprise.
• Id: string
  Maximum Length: 80

  The unique identifier of the company profile setup task.
• IsDataExisting: string
  Maximum Length: 80

  Indicates if the enterprise setup data was created before running the Setup Assistant.
• LegalEntity: string
  Maximum Length: 80

  Legal Entity
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OfferingName: string
  Maximum Length: 80

  Offering Name
• TaxRegNumber: string
  Maximum Length: 80

  Enterprise Tax Registration Number

{
    "type":"object",
    "properties":{
        "Addressline":{
            "maxLength":100,
            "type":"string",
            "description":"The first line of the organization address.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "maxLength":80,
            "type":"string",
            "description":"Business Unit",
            "nullable":true,
            "x-queryable":true
        },
        "CompanyName":{
            "maxLength":80,
            "type":"string",
            "description":"Company Name",
            "nullable":true,
            "x-queryable":true
        },
        "CorporateCurrency":{
            "maxLength":80,
            "type":"string",
            "description":"The default corporate currency code.",
            "nullable":false,
            "default":"USD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Country":{
            "maxLength":80,
            "type":"string",
            "description":"The country of the enterprise.",
            "nullable":true,
            "default":"US",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EnterpriseName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the enterprise.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the company profile setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "IsDataExisting":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates if the enterprise setup data was created before running the Setup Assistant.",
            "nullable":true,
            "x-queryable":true
        },
        "LegalEntity":{
            "maxLength":80,
            "type":"string",
            "description":"Legal Entity",
            "nullable":true,
            "x-queryable":true
        },
        "OfferingName":{
            "maxLength":80,
            "type":"string",
            "description":"Offering Name",
            "nullable":true,
            "x-queryable":true
        },
        "TaxRegNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Enterprise Tax Registration Number",
            "nullable":true,
            "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