| Requires any of the roles: | Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/AgentEmailCredentials |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AgentEmailCredentials | body | List<AgentEmailCredentials> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| AgentId | form | int | No | |
| EmailAddress | form | string | No | |
| Username | form | string | No | |
| Password | form | string | No | |
| SMTPServer | form | string | No | |
| SMTPPort | form | int? | No | |
| SMTPAuthType | form | string | No | |
| POP3Server | form | string | No | |
| POP3Port | form | int? | No | |
| POP3AuthType | form | string | No | |
| IMAPServer | form | string | No | |
| IMAPPort | form | int? | No | |
| DateCreated | form | DateTime | No | |
| DateModified | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| AgentEmailCredentials | form | List<AgentEmailCredentials> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/AgentEmailCredentials HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AgentEmailCredentialsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentEmailCredentials>
<AgentEmailCredentials>
<AgentId>0</AgentId>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateModified>0001-01-01T00:00:00</DateModified>
<EmailAddress>String</EmailAddress>
<IMAPPort>0</IMAPPort>
<IMAPServer>String</IMAPServer>
<Id>0</Id>
<POP3AuthType>String</POP3AuthType>
<POP3Port>0</POP3Port>
<POP3Server>String</POP3Server>
<Password>String</Password>
<SMTPAuthType>String</SMTPAuthType>
<SMTPPort>0</SMTPPort>
<SMTPServer>String</SMTPServer>
<Username>String</Username>
</AgentEmailCredentials>
</AgentEmailCredentials>
</AgentEmailCredentialsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentEmailCredentialsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentEmailCredentials>
<AgentEmailCredentials>
<AgentId>0</AgentId>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateModified>0001-01-01T00:00:00</DateModified>
<EmailAddress>String</EmailAddress>
<IMAPPort>0</IMAPPort>
<IMAPServer>String</IMAPServer>
<Id>0</Id>
<POP3AuthType>String</POP3AuthType>
<POP3Port>0</POP3Port>
<POP3Server>String</POP3Server>
<Password>String</Password>
<SMTPAuthType>String</SMTPAuthType>
<SMTPPort>0</SMTPPort>
<SMTPServer>String</SMTPServer>
<Username>String</Username>
</AgentEmailCredentials>
</AgentEmailCredentials>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</AgentEmailCredentialsResponse>