POST api/v1/customers

Request Information

URI Parameters

None.

Body Parameters

CustomerDto
NameDescriptionTypeAdditional information
OrganizationCode

string

None.

Id

globally unique identifier

None.

Dni

string

None.

DniValidated

boolean

None.

LastName

string

None.

FirstName

string

None.

HasProgeny

boolean

None.

HasCard

boolean

None.

AnyOnlinePurchase

boolean

None.

AnyOfflinePurchase

boolean

None.

BirthDate

date

None.

Gender

Gender

None.

Email

string

None.

EmailStatus

EmailStatus

None.

ZipCode

string

None.

Address

string

None.

MobilePhone

string

None.

ExtraPhone

string

None.

Annotations

string

None.

HasEnabledNotifications

boolean

None.

HasAcceptedAdvertising

boolean

None.

HasAcceptedDataCession

boolean

None.

HasAcceptedBirthdayGreeting

boolean

None.

SourceCode

string

None.

IsMember

boolean

None.

Rank

string

None.

EstimatedDateOfBirth

date

None.

UrlPhoto

string

None.

PhotoBase64

string

None.

AllowsCommunications

boolean

None.

AllowsNotifications

boolean

None.

IsArchived

boolean

None.

WinId

string

None.

CustomFields

Dictionary of string [key] and CustomFieldCustomerDto [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "organizationCode": "sample string 1",
  "id": "6e7de5b8-1b81-4341-8c15-29fd2bc612be",
  "dni": "sample string 2",
  "dniValidated": true,
  "lastName": "sample string 4",
  "firstName": "sample string 5",
  "hasProgeny": true,
  "hasCard": true,
  "anyOnlinePurchase": true,
  "anyOfflinePurchase": true,
  "birthDate": "2025-08-31T09:12:12.0193874+00:00",
  "gender": 0,
  "email": "sample string 9",
  "emailStatus": 0,
  "zipCode": "sample string 10",
  "address": "sample string 11",
  "mobilePhone": "sample string 12",
  "extraPhone": "sample string 13",
  "annotations": "sample string 14",
  "hasEnabledNotifications": true,
  "hasAcceptedAdvertising": true,
  "hasAcceptedDataCession": true,
  "hasAcceptedBirthdayGreeting": true,
  "sourceCode": "sample string 15",
  "isMember": true,
  "rank": "sample string 17",
  "estimatedDateOfBirth": "2025-08-31T09:12:12.0193874+00:00",
  "urlPhoto": "sample string 18",
  "photoBase64": "sample string 19",
  "allowsCommunications": true,
  "allowsNotifications": true,
  "isArchived": true,
  "winId": "sample string 20",
  "customFields": {
    "sample string 1": {
      "code": "sample string 1",
      "name": "sample string 2",
      "stringValue": "sample string 3",
      "dateTimeValue": "2025-08-31T09:12:12.0193874+00:00",
      "intValue": 1,
      "boolValue": true,
      "type": "sample string 4"
    },
    "sample string 2": {
      "code": "sample string 1",
      "name": "sample string 2",
      "stringValue": "sample string 3",
      "dateTimeValue": "2025-08-31T09:12:12.0193874+00:00",
      "intValue": 1,
      "boolValue": true,
      "type": "sample string 4"
    }
  }
}

application/xml, text/xml

Sample:
<CustomerDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Domain.Dtos">
  <Address>sample string 11</Address>
  <AllowsCommunications>true</AllowsCommunications>
  <AllowsNotifications>true</AllowsNotifications>
  <Annotations>sample string 14</Annotations>
  <AnyOfflinePurchase>true</AnyOfflinePurchase>
  <AnyOnlinePurchase>true</AnyOnlinePurchase>
  <BirthDate>2025-08-31T09:12:12.0193874+00:00</BirthDate>
  <CustomFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringCustomFieldCustomerDtouOHOlRpi>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <BoolValue>true</BoolValue>
        <Code>sample string 1</Code>
        <DateTimeValue>2025-08-31T09:12:12.0193874+00:00</DateTimeValue>
        <IntValue>1</IntValue>
        <Name>sample string 2</Name>
        <StringValue>sample string 3</StringValue>
        <Type>sample string 4</Type>
      </d2p1:Value>
    </d2p1:KeyValueOfstringCustomFieldCustomerDtouOHOlRpi>
    <d2p1:KeyValueOfstringCustomFieldCustomerDtouOHOlRpi>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <BoolValue>true</BoolValue>
        <Code>sample string 1</Code>
        <DateTimeValue>2025-08-31T09:12:12.0193874+00:00</DateTimeValue>
        <IntValue>1</IntValue>
        <Name>sample string 2</Name>
        <StringValue>sample string 3</StringValue>
        <Type>sample string 4</Type>
      </d2p1:Value>
    </d2p1:KeyValueOfstringCustomFieldCustomerDtouOHOlRpi>
  </CustomFields>
  <Dni>sample string 2</Dni>
  <DniValidated>true</DniValidated>
  <Email>sample string 9</Email>
  <EmailStatus>Checked</EmailStatus>
  <EstimatedDateOfBirth>2025-08-31T09:12:12.0193874+00:00</EstimatedDateOfBirth>
  <ExtraPhone>sample string 13</ExtraPhone>
  <FirstName>sample string 5</FirstName>
  <Gender>Male</Gender>
  <HasAcceptedAdvertising>true</HasAcceptedAdvertising>
  <HasAcceptedBirthdayGreeting>true</HasAcceptedBirthdayGreeting>
  <HasAcceptedDataCession>true</HasAcceptedDataCession>
  <HasCard>true</HasCard>
  <HasEnabledNotifications>true</HasEnabledNotifications>
  <HasProgeny>true</HasProgeny>
  <Id>6e7de5b8-1b81-4341-8c15-29fd2bc612be</Id>
  <IsArchived>true</IsArchived>
  <IsMember>true</IsMember>
  <LastName>sample string 4</LastName>
  <MobilePhone>sample string 12</MobilePhone>
  <OrganizationCode>sample string 1</OrganizationCode>
  <PhotoBase64>sample string 19</PhotoBase64>
  <Rank>sample string 17</Rank>
  <SourceCode>sample string 15</SourceCode>
  <UrlPhoto>sample string 18</UrlPhoto>
  <WinId>sample string 20</WinId>
  <ZipCode>sample string 10</ZipCode>
</CustomerDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.